Custom Fields V2Version: v3

Update Custom Field By Id

PUT/custom-fields/{id}

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

Path Parameters

idstringrequired

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. Important: Providing options will completely replace the existing options array. You must include all existing options alongside any new options you wish to add. Removal of options is not supported through this update. Applicable only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST types.

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

maxFileLimitnumber

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

Example:2

Response

application/json

Successful response

fieldobject

field.locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

field.namestring

Field name

Example:Name

field.descriptionstring

Description of the field

field.placeholderstring

Placeholder text for the field

field.showInFormsbooleanrequired

Whether the field should be shown in forms

field.optionsobject[]

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

field.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

field.idstringrequired

Unique identifier of the object

field.objectKeystringrequired

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

Example:custom_object.pet

field.dataTypestringrequired

Type of field that you are trying to create

Available optionsTEXTLARGE_TEXTNUMERICALPHONEMONETORYCHECKBOXSINGLE_OPTIONSMULTIPLE_OPTIONSDATETEXTBOX_LISTFILE_UPLOADRADIO

field.parentIdstringrequired

ID of the parent folder

Example:3v34PM428h8vShlRW1KT

field.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 "{fieldName}" 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

field.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

field.maxFileLimitnumber

Maximum file limit for uploads

Example:2

field.dateAddedstring<date-time>required

Date and time when the object was added

field.dateUpdatedstring<date-time>required

Date and time when the object was last updated

Update Custom Field By Id

Authorizations

Request​

Headers

Path Parameters

Body

Response

Request