Update Custom Field

PUT 
/api/custom-fields/:customField

Updates an existing custom field. All fields are optional.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Authentication: Requires Bearer token.

Fields (all optional):

• name (optional) — Display name of the custom field. Must be unique within the same link_type (the record's own existing name is allowed).
• link_type (optional) — Fully qualified model class name
• archived_at (optional, nullable, date) — Set to a date to archive, null to unarchive

Uniqueness: The (name, link_type) combination must be unique. Renaming to a name that already exists for the same link_type returns 422 with a friendly error message instead of a 500.

Request

Responses

200

OK

Response Headers

Content-Type

401

Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.

403

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.

404

Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.

422

Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.

429

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.