Skip to main content
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 Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT
idstringrequired

Custom Field Id

Example:00NhGCcN1tlO8ZHcu7Wb

Body

namestringrequired
Example:Custom Field
placeholderstring
Example:Placeholder Text
acceptedFormatstring[]
Example:[".pdf",".docx",".jpeg"]
isMultipleFileboolean
Example:false
maxNumberOfFilesnumber
Example:2
textBoxListOptionsobject[]
positionnumber
Default:0
Example:0
modelstring

Model of the custom field you want to update

Available optionscontactopportunity
Example:opportunity
urlValidationobject

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 optionsTEXT_ONLYTEXT_WITH_ICONTEXT_WITH_IMAGE
Example:TEXT_WITH_IMAGE

Response

Successful response

customFieldobject