Skip to content

customObjectFields

Platform module · 5 operations

List custom object field rows

GET/custom-object-fields

A typed field of a custom object type. Returns a cursor page of custom object field rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a custom object field

POST/custom-object-fields

A typed field of a custom object type. Creates a custom object field. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a custom object field

GET/custom-object-fields/{id}

A typed field of a custom object type. Returns one custom object field with its `ETag`. A custom object field the caller may not see returns 404.

Update a custom object field

PATCH/custom-object-fields/{id}

A typed field of a custom object type. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a custom object field

DELETE/custom-object-fields/{id}

A typed field of a custom object type. Soft-deletes the custom object field: it moves to Trash and can be restored for its table's retention period.