Create Custom Field

POST 
/locations/:locationId/customFields

Create Custom Field

Request

Version stringrequired

API Version

Available optionsv3

locationId stringrequired

Location Id

application/json

application/json

Body

Bodyrequired

namestringrequired
dataTypestringrequired
placeholderstring
acceptedFormatstring[]
isMultipleFileboolean
maxNumberOfFilesnumber
textBoxListOptionsobject[]
positionnumber
Default value: 0
modelstring
Model of the custom field you want to create
Available optionscontactopportunity

Example (auto)

{
  "name": "Custom Field",
  "dataType": "TEXT",
  "placeholder": "Placeholder Text",
  "acceptedFormat": [
    ".pdf",
    ".docx",
    ".jpeg"
  ],
  "isMultipleFile": false,
  "maxNumberOfFiles": 2,
  "textBoxListOptions": [
    {
      "label": "First",
      "prefillValue": ""
    },
    {
      "label": "First",
      "prefillValue": ""
    }
  ],
  "position": 0,
  "model": "opportunity"
}

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"
  }
}