Skip to main content
PATCH
Update Contact Custom Field
Updates an existing custom field definition for contacts.

Path parameters

  • id (string, required): The unique identifier of the custom field definition.

Required permissions

Requires an API key with the crm:write scope.

Authorizations

x-api-key
string
header
required

Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.

Path Parameters

id
string
required

The unique identifier of the custom field

Body

application/json
field_name
string
Example:

"Alliance Tier"

options
string[]
Example:
is_required
boolean
Example:

true

Response

Contact custom field updated successfully

Standard envelope returned by POST, PATCH, PUT, and DELETE (mutation) endpoints

success
boolean
required
Example:

true

data
object
required

The created or updated entity

error
null
required
Example:

null