Skip to main content
Custom Fields V2Version: v3

Create Custom Field

POST/custom-fields

Create Custom Field

info

Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future.

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

Body

application/json
locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT
namestring

Field name

Example:Name
descriptionstring

Description of the field

placeholderstring

Placeholder text for the field

showInFormsbooleanrequired

Whether the field should be shown in forms

optionsobject[]

Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)

acceptedFormatsstring

Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all

Available options.pdf.docx.doc.jpg.jpeg.png.gif.csv.xlsx.xlsall
dataTypestringrequired

Type of field that you are trying to create

Available optionsTEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSDATETEXTBOX_LISTFILE_UPLOADRADIO
fieldKeystringrequired

Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldKey}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.

Example:custom_object.pet.name
objectKeystringrequired

The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

Example:custom_object.pet
maxFileLimitnumber

Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.

Example:2
allowCustomOptionboolean

Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.

Example:true
parentIdstringrequired

ID of the parent folder

Response

application/json

Successful response

fieldobject