Custom FieldVersion: v3
Create Custom Field
POST/locations/{locationId}/customFields
Create Custom Field
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
locations/ customFields. writeAuth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Path Parameters
locationIdstringrequired
Location Id
Example:
ve9EPM428h8vShlRW1KTBody
namestringrequired
Example:
Custom FielddataTypestringrequired
Data type of the custom field.
URL, USER, TIME, DATE_TIME and RICH_TEXT are Labs-only for now.
Available options
TEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSFLOATTIMEDATETEXTBOX_LISTExample:
TEXTplaceholderstring
Example:
Placeholder TextacceptedFormatstring[]
Example:
[".pdf",".docx",".jpeg"]isMultipleFileboolean
Example:
falsemaxNumberOfFilesnumber
Example:
2textBoxListOptionsobject[]
positionnumber
Default:
0Example:
0modelstring
Model of the custom field you want to create
Available options
contactopportunityExample:
opportunityurlValidationobject
URL validation rules. Required when dataType is URL.
Example
{
"mode": "allow_only",
"allowedDomains": [
"example.com"
]
}
dateTimeValidationobject
Date/time validation. Required for TIME and DATE_TIME; optional for DATE when using validation rules.
Example
{
"mode": "range",
"rangeMin": "2026-01-01",
"rangeMax": "2026-12-31"
}
userFieldConfigobject
User field options. Required when dataType is USER. multiSelect cannot be changed after create.
Example
{
"multiSelect": false
}
optionDisplayTypestring
Option rendering mode for RADIO / CHECKBOX. One of TEXT_ONLY, TEXT_WITH_ICON, TEXT_WITH_IMAGE. Defaults to TEXT_ONLY.
Available options
TEXT_ONLYTEXT_WITH_ICONTEXT_WITH_IMAGEExample:
TEXT_WITH_IMAGEResponse
Successful response
customFieldobject