Skip to navigation

Partial update a custom object instance (single-field edits)

View as Markdown

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

idlongRequired

Workspace ID (numeric). Find yours under Settings → Workspace.

Headers

X-Workspace-IdstringOptional

Request

Partial update for a custom object instance (single-field inline edits). form_fields must include at least one field that changes the object’s state; enforced at the service layer. To rename the object, send form_fields.display_name. A display-name-only no-op is rejected.

form_fieldsobjectOptional

Partial custom field values keyed by field reference_key. form_fields.display_name may be sent alone for inline name edits.

Response

Successful response