Sign in
latestOpenAPI 3.0.32026-08-20147323331.7 KB

a7231589e927

custom-fields

Update a custom field

Updates a custom field definition. Only provided fields are modified.

Rate limit: 20 requests per minute

patch/custom-fields/{id}

Path parameters

idstring required

The ID of the custom field.

Request body

default_valuestring

The default value for single-valued custom fields.

default_valuesstring[]

The default values for multi-valued custom fields.

descriptionstring

The description of the custom field.

labelstring

The label of the custom field.

slugstring

The slug of the custom field.

Response

request_idstring

The request ID for tracking.

Example response

{
  "data": {
    "object_type": "account",
    "type": "text"
  }
}