ghl_create_custom_field
Create a new custom field for custom objects or company (business). Supports various field types including text, number, options, date, file upload, etc.
This record as markdown: /tools/ghl/ghl-create-custom-field.md
What ghl_create_custom_field does on Ghl
AI agents use ghl_create_custom_field to create or update resources in Ghl, usually the action step of a workflow, after the agent has gathered context. Every call changes real data in your Ghl environment.
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | — | Field name (optional for some field types) |
options | array | — | Options for the field (required for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST types) |
dataType | string | Yes | Type of field to create |
fieldKey | string | Yes | Field key. Format: "custom_object.{objectKey}.{fieldKey}" for custom objects. Example: "custom_object.pet.name" |
parentId | string | Yes | ID of the parent folder for organization |
objectKey | string | Yes | The object key. Format: "custom_object.{objectKey}" for custom objects. Example: "custom_object.pet" |
locationId | string | — | GoHighLevel location ID (will use default if not provided) |
description | string | — | Description of the field |
placeholder | string | — | Placeholder text for the field |
showInForms | boolean | — | Whether the field should be shown in forms |
maxFileLimit | number | — | Maximum file limit for uploads (only for FILE_UPLOAD type) |
acceptedFormats | string | — | Allowed file formats for uploads (only for FILE_UPLOAD type) |
Parameters from the server's own tool schema.
Why ghl_create_custom_field is rated Medium
This tool creates new custom fields, which is a Write operation—it modifies the data structure of custom objects or company records by adding new field definitions. This is reversible (fields can typically be deleted or modified), so it does not rise to Destructive level.
From the tool's definition Tool description states 'Create a new custom field' which is a reversible data creation operation. The tool creates schema-level metadata (custom fields) for custom objects or company records.
Risk signalsAccepts URL/endpoint input (options[].url) · High parameter count (16 properties)
Attacks that exploit this kind of access
The rule that runs ghl_create_custom_field safely
PolicyLayer is an MCP gateway: it sits between your AI agents and Ghl, and checks every tool call against a rule you set before the call runs. Nothing changes on the server itself. For ghl_create_custom_field, this is the rule to start with:
ghl_create_custom_field stays usable, but capped: an agent stuck in a loop can't make hundreds of changes a minute. Everything else on the server is denied unless you say otherwise.
The button opens the PolicyLayer dashboard: create your workspace, connect Ghl, apply this rule, and every ghl_create_custom_field call is checked against it from then on.
Questions about ghl_create_custom_field
Create a new custom field for custom objects or company (business). Supports various field types including text, number, options, date, file upload, etc. It is categorised as a Write tool in the Ghl MCP Server, which means it can create or modify data. Consider rate limits to prevent runaway writes.
ghl_create_custom_field accepts 12 parameters: name, options, dataType, fieldKey, parentId, objectKey, locationId, description, placeholder, showInForms, maxFileLimit, acceptedFormats. Required: dataType, fieldKey, parentId, objectKey. The full parameter table on this page comes from the server's own tool schema.
Register the Ghl MCP server in PolicyLayer and add a rule for ghl_create_custom_field: allow, deny, rate-limit, or require approval. Point your MCP client at the PolicyLayer proxy URL and the rule is enforced on every call, before it reaches Ghl. Nothing to install.
ghl_create_custom_field is a Write tool with medium risk. Write tools should be rate-limited to prevent accidental bulk modifications.
Yes. Add a rate_limit block to the ghl_create_custom_field rule in your PolicyLayer policy. For example, setting max: 10 and window: 60 limits the tool to 10 calls per minute. Rate limits are tracked per agent session and reset automatically.
Set action: deny in the PolicyLayer policy for ghl_create_custom_field. The AI agent will receive a policy violation error and cannot call the tool. You can also include a reason field to explain why the tool is blocked.
ghl_create_custom_field is provided by the Ghl MCP server (ghl-mcp-server). PolicyLayer sits as a proxy in front of this server to enforce policies before tool calls reach the server.
More on Ghl, and thousands of servers like it.
This server
Across the catalogue