v1

latestOpenAPI 3.1.02026-08-04147764567.0 KB
customObjects

Update a custom object instance

put/api/v1/custom-objects/by-id/{id}

Path parameters

idinteger required

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

Headers

X-Api-Keystring required
X-Workspace-Idstring

Request body

form_fieldsApiV1CustomObjectsByIdIdPutRequestBodyContentApplicationJsonSchemaFormFields

Partial custom field values keyed by field reference_key. To rename the object, send form_fields.display_name. If absent, the existing display name is preserved. If present, it is trimmed, must be non-empty/ non-whitespace, and must be at most 255 characters.

Response

Successful response

CustomObjectsPutapiV1CustomObjectsByIdIdResponse200 required

Empty response body