Custom FieldVersion: v3
Update Custom Field
PUT/locations/{locationId}/customFields/{id}
Update Custom Field
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Auth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Path Parameters
locationIdstringrequired
Location Id
Example:
ve9EPM428h8vShlRW1KTidstringrequired
Custom Field Id
Example:
00NhGCcN1tlO8ZHcu7WbBody
namestringrequired
Example:
Custom Fieldplaceholderstring
Example:
Placeholder TextacceptedFormatstring[]
Example:
[".pdf",".docx",".jpeg"]isMultipleFileboolean
Example:
falsemaxNumberOfFilesnumber
Example:
2textBoxListOptionsobject[]
positionnumber
Default:
0Example:
0modelstring
Model of the custom field you want to update
Available options
contactopportunityExample:
opportunityurlValidationobject
When provided, replaces URL validation rules (URL fields only).
Example
{
"mode": "allow_only",
"allowedDomains": [
"example.com"
]
}
dateTimeValidationobject
When provided, replaces date/time validation rules (DATE, TIME, DATE_TIME fields only).
Example
{
"mode": "range",
"rangeMin": "2026-01-01",
"rangeMax": "2026-12-31"
}
userFieldConfigobject
When provided, updates user field options except multiSelect (immutable after create).
Example
{
"multiSelect": false
}
optionDisplayTypestring
When provided, updates the option rendering mode (RADIO / CHECKBOX only). One of TEXT_ONLY, TEXT_WITH_ICON, TEXT_WITH_IMAGE.
Available options
TEXT_ONLYTEXT_WITH_ICONTEXT_WITH_IMAGEExample:
TEXT_WITH_IMAGEResponse
Successful response
customFieldobject