customFieldDefinitions
Platform module · 5 operations
List custom field definition rows
GET/custom-field-definitions
A custom field on a built-in resource. Returns a cursor page of custom field definition rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.
Create a custom field definition
POST/custom-field-definitions
A custom field on a built-in resource. Creates a custom field definition. 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 field definition
GET/custom-field-definitions/{id}
A custom field on a built-in resource. Returns one custom field definition with its `ETag`. A custom field definition the caller may not see returns 404.
Update a custom field definition
PATCH/custom-field-definitions/{id}
A custom field on a built-in resource. 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 field definition
DELETE/custom-field-definitions/{id}
A custom field on a built-in resource. Soft-deletes the custom field definition: it moves to Trash and can be restored for its table's retention period.