Skip to main content

Create Custom Field

POST 
//:domain/api/custom-fields

Creates a new custom field definition. Custom fields are then attached to records via the custom-field-values API.

Authentication: Requires Bearer token.

Fields:

  • name (required) — Display name of the custom field. Must be unique within the same link_type.
  • link_type (required) — Fully qualified model class name the field applies to (e.g., App\Models\PurchaseOrder)

Uniqueness: The (name, link_type) combination must be unique. Attempting to create a duplicate returns 422 with a friendly error message instead of a 500.

Request​

Responses​

OK

Response Headers
    Content-Type