Tables

Update table

Update a table.

patch/orgs/tables/{table_id}

Request

  • Base URL: https://api.useinvent.com
  • URL: https://api.useinvent.com/orgs/tables/{table_id}
  • Auth: HTTP bearer

Path parameters

table_idstring required

Table ID

Request body

namestring

Human-readable name (e.g. "Companies"). 1-128 chars.

descriptionstring nullable

Optional long-form description of what the table represents.

color'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral'

Accent color, by name

display_field_idstring nullable

Encoded id of the TableField whose value renders as the record headline. Must belong to this table and not be archived. Pass null to clear.

archivedboolean

Visibility flag. Archived tables are hidden from default lists. No effect on records, fields, or behavior; reversible at any time.

Response

idstring required
type'custom' | 'contacts' | 'chats' | 'users' required
namestring nullable required

The name of the table.

descriptionstring nullable required

The description of the table.

color'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral' required

Accent color, by name

display_field_idstring nullable required

The id of the display field.

archivedboolean required

Whether the table is archived.

positioninteger required

Manual display order within the org.

created_atstring date-time nullable required
updated_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.