Skip to main content
PATCH
Partially update a custom field definition

Authorizations

Authorization
string
header
required

Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.

Path Parameters

customFieldId
integer
required

The unique identifier of the custom field definition

Body

application/json

Any subset of the writable custom field fields. All keys are optional; include only what you want to change.

label
string

New display label (must remain unique across definitions).

Maximum string length: 255
Example:

"Industry Segment"

type
enum<string>

Data type of the custom field. Changing type may require also sending options (e.g. switching to dropdown requires a non-empty choices array).

Available options:
number,
date,
string,
dropdown
Example:

"dropdown"

options
object | null

Replace the options blob. Send null to clear. For dropdown fields, prefer the /choices PATCH endpoint to add/remove individual choices without resending the whole list.

object_types
string[]

Replace the list of linked entity types. Pass an empty array to unlink from all entity types. Omit the key entirely to leave the current linkage untouched.

Example:

Response

Custom field definition successfully patched

data
object