Create Custom Field
POST/api/custom-fields
Creates a new custom field definition. Custom fields are then attached to records via the custom-field-values API.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
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
- 200
- 401
- 403
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.