Type of field that you are trying to create Possible values: 'TEXT', 'LARGE_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE_OPTIONS', 'MULTIPLE_OPTIONS', 'DATE', 'TEXTBOX_LIST', 'FILE_UPLOAD', 'RADIO', 'EMAIL'
fieldKey
string
Yes
custom_object.pet.name
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.
objectKey
string
Yes
custom_object.pet
The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
maxFileLimit
number
No
2
Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.
allowCustomOption
boolean
No
True
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.
parentId
string
Yes
ID of the parent folder
Responses
201 - Successful response
field (object)
locationId (string, required): Account Id Example: ve9EPM428h8vShlRW1KT
name (string): Field name Example: Name
description (string): Description of the field
placeholder (string): Placeholder text for the field
showInForms (boolean, required): Whether the field should be shown in forms
options (object[]): Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
key (string, required): Key of the option (Included in Create and Response, excluded in Update)
label (string, required): Value of the option
url (string): URL associated with the option (Optional, valid only for RADIO type)
id (string, required): Unique identifier of the object
objectKey (string, required): 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
dataType (string, required): Type of field that you are trying to create Possible values: 'TEXT', 'LARGE_TEXT', 'NUMERICAL', 'PHONE', 'MONETORY', 'CHECKBOX', 'SINGLE_OPTIONS', 'MULTIPLE_OPTIONS', 'DATE', 'TEXTBOX_LIST', 'FILE_UPLOAD', 'RADIO'
parentId (string, required): ID of the parent folder Example: 3v34PM428h8vShlRW1KT
fieldKey (string, required): 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
allowCustomOption (boolean): 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
maxFileLimit (number): Maximum file limit for uploads Example: 2
dateAdded (string, required): Date and time when the object was added
dateUpdated (string, required): Date and time when the object was last updated