Skip to main content
PATCH
Update a custom field

Authorizations

Authorization
string
header
required

OAuth 2.1 access token.

Path Parameters

identifier
string
required

Custom field id (UUID) or key (string). Both formats are accepted.

Body

application/json

All fields are optional. Only fields included in the body are modified.

label
string

New display label.

Required string length: 1 - 40
Example:

"Federal Tax ID"

type
enum<string>

New field type.

Available options:
text,
long_text,
select,
multi_select,
cpf,
cnpj,
date,
number,
link,
address
value
object

Updates the options for select and multi_select fields. Replaces the entire existing list. Must be omitted for all other field types.

Example:
required
boolean

Update required flag.

Example:

true

show_people
boolean

Update visibility on people records.

Example:

true

show_companies
boolean

Update visibility on company records.

Example:

false

show_deals
boolean

Update visibility on deal records.

Example:

true

Response

Custom field updated successfully.

data
object