Skip to main content
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.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

Body

namestringrequired
Example:Custom Field
dataTypestringrequired

Data type of the custom field.

URL, USER, TIME, DATE_TIME and RICH_TEXT are Labs-only for now.

Available optionsTEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSFLOATTIMEDATETEXTBOX_LIST
Example:TEXT
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 create

Available optionscontactopportunity
Example:opportunity
urlValidationobject

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

Response

Successful response

customFieldobject