Create Custom Field

POST 
/locations/:locationId/customFields

Create Custom Field

Request

Version stringrequired

API Version

Available options2021-07-28

locationId stringrequired

Location Id

application/json

application/json

Body

Bodyrequired

namestringrequired
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
placeholderstring
acceptedFormatstring[]
isMultipleFileboolean
maxNumberOfFilesnumber
textBoxListOptionsobject[]
positionnumber
Default value: 0
modelstring
Model of the custom field you want to create
Available optionscontactopportunity
urlValidationobject

URL validation rules. Required when dataType is URL.

dateTimeValidationobject

Date/time validation. Required for TIME and DATE_TIME; optional for DATE when using validation rules.

userFieldConfigobject

User field options. Required when dataType is USER. multiSelect cannot be changed after create.

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 (auto)

{
  "name": "Custom Field",
  "dataType": "TEXT",
  "placeholder": "Placeholder Text",
  "acceptedFormat": [
    ".pdf",
    ".docx",
    ".jpeg"
  ],
  "isMultipleFile": false,
  "maxNumberOfFiles": 2,
  "textBoxListOptions": [
    {
      "label": "First",
      "prefillValue": ""
    }
  ],
  "position": 0,
  "model": "opportunity",
  "urlValidation": {
    "mode": "allow_only",
    "allowedDomains": [
      "example.com"
    ]
  },
  "dateTimeValidation": {
    "mode": "range",
    "rangeMin": "2026-01-01",
    "rangeMax": "2026-12-31"
  },
  "userFieldConfig": {
    "multiSelect": false
  },
  "optionDisplayType": "TEXT_WITH_IMAGE"
}

application/json

Successful response

application/json

Schema

Schema

customFieldobject

Example (auto)

{
  "customField": {
    "id": "3sv6UEo51C9Bmpo1cKTq",
    "name": "pincode",
    "fieldKey": "contact.pincode",
    "placeholder": "Pin code",
    "dataType": "TEXT",
    "position": 0,
    "picklistOptions": [
      "first option"
    ],
    "picklistImageOptions": [],
    "isAllowedCustomOption": false,
    "isMultiFileAllowed": true,
    "maxFileLimit": 4,
    "locationId": "3sv6UEo51C9Bmpo1cKTq",
    "model": "opportunity",
    "urlValidation": {
      "mode": "allow_only",
      "allowedDomains": [
        "example.com"
      ]
    },
    "dateTimeValidation": {
      "mode": "range",
      "rangeMin": "2026-01-01",
      "rangeMax": "2026-12-31"
    },
    "userFieldConfig": {
      "multiSelect": false
    },
    "optionDisplayType": "TEXT_WITH_IMAGE"
  }
}