Skip to main content

Update Custom Field

PUT 
//:domain/api/custom-fields/:custom_field

Updates an existing custom field. All fields are optional.

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​

OK

Response Headers
    Content-Type