custom_fields_create_custom_field
Create custom fields in GoHighLevel by specifying data type, field key, and object key, with options for forms, file uploads, and custom values.
Instructions
Create Custom Field
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"showInForms": "<showInForms>",
"dataType": "<dataType>",
"fieldKey": "<fieldKey>",
"objectKey": "<objectKey>",
"parentId": "<parentId>"
},
"name": "custom_fields_create_custom_field"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | Field name | |
| options | No | Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type) | |
| dataType | Yes | Type of field that you are trying to create | |
| fieldKey | Yes | 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" cu | |
| parentId | Yes | ID of the parent folder | |
| objectKey | Yes | The key for your custom object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets. | |
| locationId | No | Location Id Defaults to GHL_LOCATION_ID when omitted. | |
| description | No | Description of the field | |
| placeholder | No | Placeholder text for the field | |
| showInForms | Yes | Whether the field should be shown in forms | |
| maxFileLimit | No | Maximum file limit for uploads. Applicable only for fields with a data type of FILE_UPLOAD. | |
| acceptedFormats | No | Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all | |
| allowCustomOption | No | 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. |