HighLevel: Custom fields schemas

← Custom fields operations · All schemas

Create Custom Field Folder — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location Id
name	string	Required within parent	Field name
objectKey	string	Required within parent	The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

Create Custom Field Folder — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	Unique identifier of the object
locationId	string	Required within parent	Location Id
name	string	Required within parent	Field name
objectKey	string	Required within parent	The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

Create Custom Field — custom Fields create Custom Field — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
acceptedFormats	string	Optional	Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all One of: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
allowCustomOption	boolean	Optional	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.
dataType	string	Required within parent	Type of field that you are trying to create One of: TEXT, LARGE_TEXT, NUMERICAL, PHONE, MONETORY, CHECKBOX, SINGLE_OPTIONS, MULTIPLE_OPTIONS, DATE, TEXTBOX_LIST, FILE_UPLOAD, RADIO, EMAIL
description	string	Optional	Description of the field
fieldKey	string	Required within parent	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.
locationId	string	Required within parent	Location Id
maxFileLimit	number	Optional	Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.
name	string	Optional	Field name
objectKey	string	Required within parent	The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.
options	array	Optional	Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
options[]	Model	Each item	Expand Update Custom Field By Id — request body — body options item
parentId	string	Required within parent	ID of the parent folder
placeholder	string	Optional	Placeholder text for the field
showInForms	boolean	Required within parent	Whether the field should be shown in forms

Referenced models: Update Custom Field By Id — request body — body options item

Delete Custom Field By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent
key	string	Required within parent
succeded	boolean	Required within parent

Get Custom Fields By Object Key — response body

Field	Type	Presence	Description and constraints
$	object	Root
fields	array	Optional	Custom Fields for the object.
fields[]	Model	Each item	Expand Update Custom Field By Id — response body — field
folders	array	Optional	Custom Fields folder for the object.
folders[]	Model	Each item	Expand Update Custom Field By Id — response body — field

Referenced models: Update Custom Field By Id — response body — field

Update Custom Field By Id — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
acceptedFormats	string	Optional	Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all One of: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
description	string	Optional	Description of the field
locationId	string	Required within parent	Location Id
maxFileLimit	number	Optional	Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD.
name	string	Optional	Field name
options	array	Optional	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.
options[]	Model	Each item	Expand Update Custom Field By Id — request body — body options item
placeholder	string	Optional	Placeholder text for the field
showInForms	boolean	Required within parent	Whether the field should be shown in forms

Referenced models: Update Custom Field By Id — request body — body options item

Update Custom Field By Id — request body — body options item

Field	Type	Presence	Description and constraints
$	object	Root
key	string	Required within parent	Key of the option (Included in Create and Response, excluded in Update)
label	string	Required within parent	Value of the option
url	string	Optional	URL associated with the option (Optional, valid only for RADIO type)

Update Custom Field By Id — response body

Field	Type	Presence	Description and constraints
$	object	Root
field	Model	Optional	Expand Update Custom Field By Id — response body — field

Referenced models: Update Custom Field By Id — response body — field

Update Custom Field By Id — response body — field

Field	Type	Presence	Description and constraints
$	object	Root
acceptedFormats	string	Optional	Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all Known values: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all
allowCustomOption	boolean	Optional	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.
dataType	string	Required within parent	Type of field that you are trying to create Known values: TEXT, LARGE_TEXT, NUMERICAL, PHONE, MONETORY, CHECKBOX, SINGLE_OPTIONS, MULTIPLE_OPTIONS, DATE, TEXTBOX_LIST, FILE_UPLOAD, RADIO
dateAdded	string	Required within parent	Date and time when the object was added Format: date-time
dateUpdated	string	Required within parent	Date and time when the object was last updated Format: date-time
description	string	Optional	Description of the field
fieldKey	string	Required within parent	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.
id	string	Required within parent	Unique identifier of the object
locationId	string	Required within parent	Location Id
maxFileLimit	JSON	Optional
maxFileLimit (anyOf 1)	number	Alternative	Maximum file limit for uploads
maxFileLimit (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
name	string	Optional	Field name
objectKey	string	Required within parent	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.
options	array	Optional	Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)
options[]	Model	Each item	Expand Update Custom Field By Id — request body — body options item
parentId	string	Required within parent	ID of the parent folder
placeholder	string	Optional	Placeholder text for the field
showInForms	boolean	Required within parent	Whether the field should be shown in forms

Referenced models: Update Custom Field By Id — request body — body options item

Update Custom Field Folder Name — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
locationId	string	Required within parent	Location Id
name	string	Required within parent	Field name