Skip to main content
PATCH
Update a custom field definition

Authorizations

Authorization
string
header
required

OAuth 2.0 access token for a connected application. Limited to the scopes granted at consent.

Headers

authorization
string
required

Bearer token for API authentication

Idempotency-Key
string

Makes retries safe. A retry with the same key and the same request replays the stored response for 24 hours (header Idempotent-Replayed: true); the same key with a different request returns 400.

Maximum string length: 255

Path Parameters

id
string
required

Body

application/json

Body

name
string
Minimum string length: 1
inputType
enum<string>
Available options:
TEXT,
NUMBER,
DATE,
EMAIL,
PHONE,
URL,
BOOLEAN,
SELECT,
JSON,
TEXTAREA
defaultValue
string | null
required
boolean
options
string | null

Response

200

id
string
required

Unique custom field identifier

name
string
required

Custom field name

type
enum<string>
required

Field type: DOCUMENT or CONTACT

Available options:
DOCUMENT,
CONTACT
inputType
enum<string>
required

Input type: TEXT, NUMBER, DATE, CHECKBOX, SELECT, TEXTAREA, EMAIL, PHONE, or URL

Available options:
TEXT,
NUMBER,
DATE,
EMAIL,
PHONE,
URL,
BOOLEAN,
SELECT,
JSON,
TEXTAREA
defaultValue
string | null
required

Default value for this field

required
boolean
required

Whether this field is required

options
string | null
required

Comma-separated options for SELECT type fields

createdAt
string<date-time>
required

Date and time when custom field was created

updatedAt
string<date-time>
required

Date and time when custom field was last updated