Skip to main content
PATCH
/
orgs
/
{org_id}
/
tables
/
{table_id}
/
fields
/
{field_id}
Update a table field
curl --request PATCH \
  --url https://api.useinvent.com/orgs/{org_id}/tables/{table_id}/fields/{field_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "schema": {
    "name": "<string>",
    "description": "<string>",
    "optional": true,
    "array": true,
    "placeholder": "<string>",
    "display": {},
    "order": 1,
    "link": "<string>",
    "metadata": {},
    "allowed_modes": [],
    "broadcast_hidden": true,
    "broadcast_field": true,
    "integration_field": true,
    "display_field": true,
    "conditions": [
      {
        "field": "<string>",
        "value": "<unknown>"
      }
    ],
    "hidden": true,
    "picker": {
      "views": [],
      "selectable_mime_types": [
        "<string>"
      ]
    },
    "disable_variables": true,
    "allowed_types": [
      "<string>"
    ],
    "visibility": "PRIVATE"
  },
  "config": {},
  "connection_id": "<string>",
  "unique": true,
  "readonly": true,
  "archived": true
}
'
{
  "id": "<string>",
  "table_id": "<string>",
  "key": "<string>",
  "schema": {
    "name": "<string>",
    "description": "<string>",
    "optional": true,
    "array": true,
    "placeholder": "<string>",
    "display": {},
    "order": 1,
    "link": "<string>",
    "metadata": {},
    "allowed_modes": [],
    "broadcast_hidden": true,
    "broadcast_field": true,
    "integration_field": true,
    "display_field": true,
    "conditions": [
      {
        "field": "<string>",
        "value": "<unknown>"
      }
    ],
    "hidden": true,
    "picker": {
      "views": [],
      "selectable_mime_types": [
        "<string>"
      ]
    },
    "disable_variables": true,
    "allowed_types": [
      "<string>"
    ],
    "visibility": "PRIVATE"
  },
  "readonly": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.useinvent.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

​
org_id
string
required

Org ID

​
table_id
string
required

Table ID

​
field_id
string
required

Field ID

Body

​
key
string
Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9_]{0,63}$
​
schema
object

A table field schema

​
config
object

Per-feature config map keyed by feature name (e.g. button, auto_fill, sync). Each value carries input + optional definitions.

​
connection_id
string | null
Maximum string length: 128
​
unique
boolean
​
readonly
boolean

Whether the field is readonly.

​
archived
boolean

Whether the field is archived.

​
ai_mode
enum<string>
Available options:
none,
auto_fill
​
on_target_delete
enum<string>

What happens when the referenced target is deleted (ref-typed fields only). restrict forbids deleting the target while any cell still points to it. clear allows the delete and drops those field values on remaining rows. cascade also deletes table rows that reference the target via this field.

Available options:
restrict,
clear,
cascade

Response

200 - application/json
​
id
string
required
​
table_id
string
required
​
key
string
required
​
type
enum<string>
required
Available options:
string,
number,
boolean,
date,
datetime,
enum,
file,
record,
contact,
user,
chat,
segment,
assistant
​
schema
object
required

The file type allows users to upload files

​
readonly
boolean
required
​
kind
enum<string>
required
Available options:
system