Skip to main content
PATCH
/
orgs
/
{org_id}
/
records
/
{record_id}
Update a record
curl --request PATCH \
  --url https://api.useinvent.com/orgs/{org_id}/records/{record_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "values": {},
  "icon": "<string>",
  "archived": true
}
'
import requests

url = "https://api.useinvent.com/orgs/{org_id}/records/{record_id}"

payload = {
"values": {},
"icon": "<string>",
"archived": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({values: {}, icon: '<string>', archived: true})
};

fetch('https://api.useinvent.com/orgs/{org_id}/records/{record_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useinvent.com/orgs/{org_id}/records/{record_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'values' => [

],
'icon' => '<string>',
'archived' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.useinvent.com/orgs/{org_id}/records/{record_id}"

payload := strings.NewReader("{\n \"values\": {},\n \"icon\": \"<string>\",\n \"archived\": true\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://api.useinvent.com/orgs/{org_id}/records/{record_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"values\": {},\n \"icon\": \"<string>\",\n \"archived\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.useinvent.com/orgs/{org_id}/records/{record_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"values\": {},\n \"icon\": \"<string>\",\n \"archived\": true\n}"

response = http.request(request)
puts response.read_body
{
  "id": "<string>",
  "table_id": "<string>",
  "icon": "<string>",
  "archived": true,
  "position": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "values": [
    {
      "id": "<string>",
      "key": "<string>",
      "type": "string",
      "value": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

Org ID

record_id
string
required

Record ID

Body

values
object

Map of field key → value. Multi-value fields accept arrays; pass null or [] to clear.

icon

The emoji of a curated icon a user can pick for a table, view, field, or other entity

archived
boolean

Response

200 - application/json
id
string
required
table_id
string
required
icon
required

The picked icon. Null falls back to the table icon.

archived
boolean
required

Whether the record is archived.

position
string | null
required

The position of the record in the view.

updated_at
string<date-time> | null
required

Last modification time. Total-orders concurrent updates so caches can keep the newest copy.

values
object[]
required

The values of the record.