objects_create_custom_object_schema
Define and create a custom object schema in GoHighLevel CRM with labels, key, and primary display property details. Set singular/plural names and choose TEXT or NUMERICAL primary property type for structured data.
Instructions
Create Custom Object (requires an agency-level token, not a location PIT)
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": {
"labels": "<labels>",
"key": "<key>",
"primaryDisplayPropertyDetails": "<primaryDisplayPropertyDetails>"
},
"name": "objects_create_custom_object_schema"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | Yes | key that would be used to refer the Custom Object internally (lowercase + underscore_separated). 'custom_objects.' would be added as prefix by default | |
| labels | Yes | This is what your custom object will be called. These labels will be used to display your custom object on the UI | |
| locationId | No | Location Id Defaults to GHL_LOCATION_ID when omitted. | |
| description | No | Pet Object`s description | |
| primaryDisplayPropertyDetails | Yes | Primary property which will be displayed on the record page |