Ghl Create Custom Field

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

WRITEghl.ghl_create_custom_field

• Contract tier: agent_ready
• Risk: write
• Catalog version: 2026-07-12.2
• Descriptor hash: 7d71a75fd1bd86ab87617f12594ab6acdaabb9978986ae91d338ccfda5c28a53

Create a new custom field for custom objects or company (business). Supports various field types including text, number, options, date, file upload, etc. GHL category: App Marketplace. This writes to GoHighLevel and may change account data.

Request Body

{
  "jsonrpc": "2.0",
  "id": "ghl-ghl-create-custom-field-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.ghl_create_custom_field",
    "arguments": {
      "dataType": "TEXT",
      "fieldKey": "fieldKey_example",
      "objectKey": "objectKey_example",
      "parentId": "parentId_123",
      "name": "name_example",
      "options": [],
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "description": "description_example",
      "placeholder": "placeholder_example"
    }
  }
}

Arguments Schema

{
  "type": "object",
  "required": [
    "dataType",
    "fieldKey",
    "objectKey",
    "parentId"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Field name (optional for some field types)"
    },
    "options": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "key",
          "label"
        ],
        "properties": {
          "key": {
            "type": "string",
            "description": "Key of the option"
          },
          "url": {
            "type": "string",
            "description": "URL associated with the option (only for RADIO type)"
          },
          "label": {
            "type": "string",
            "description": "Label of the option"
          }
        }
      },
      "description": "Options for the field (required for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST types)"
    },
    "dataType": {
      "enum": [
        "TEXT",
        "LARGE_TEXT",
        "NUMERICAL",
        "PHONE",
        "MONETORY",
        "CHECKBOX",
        "SINGLE_OPTIONS",
        "MULTIPLE_OPTIONS",
        "DATE",
        "TEXTBOX_LIST",
        "FILE_UPLOAD",
        "RADIO",
        "EMAIL"
      ],
      "type": "string",
      "description": "Type of field to create"
    },
    "fieldKey": {
      "type": "string",
      "description": "Field key. Format: \"custom_object.{objectKey}.{fieldKey}\" for custom objects. Example: \"custom_object.pet.name\""
    },
    "parentId": {
      "type": "string",
      "description": "ID of the parent folder for organization"
    },
    "tenantId": {
      "type": "string",
      "description": "Tenant ID from list_tenants."
    },
    "objectKey": {
      "type": "string",
      "description": "The object key. Format: \"custom_object.{objectKey}\" for custom objects. Example: \"custom_object.pet\""
    },
    "locationId": {
      "type": "string",
      "description": "GoHighLevel location ID (will use default if not provided)"
    },
    "description": {
      "type": "string",
      "description": "Description of the field"
    },
    "placeholder": {
      "type": "string",
      "description": "Placeholder text for the field"
    },
    "showInForms": {
      "type": "boolean",
      "default": true,
      "description": "Whether the field should be shown in forms"
    },
    "maxFileLimit": {
      "type": "number",
      "description": "Maximum file limit for uploads (only for FILE_UPLOAD type)"
    },
    "strictTenant": {
      "type": "boolean",
      "default": true,
      "description": "Require tenantId to match locationId routing (default: true)."
    },
    "acceptedFormats": {
      "enum": [
        ".pdf",
        ".docx",
        ".doc",
        ".jpg",
        ".jpeg",
        ".png",
        ".gif",
        ".csv",
        ".xlsx",
        ".xls",
        "all"
      ],
      "type": "string",
      "description": "Allowed file formats for uploads (only for FILE_UPLOAD type)"
    },
    "allowCustomOption": {
      "type": "boolean",
      "description": "Allow users to add custom option values for RADIO type fields"
    },
    "includeFieldDetails": {
      "type": "boolean",
      "description": "Defaults to false. When false, returns compact created-field metadata and omits large option lists/details."
    }
  }
}

Output Schema

{
  "type": "object",
  "required": [
    "ok",
    "data",
    "error",
    "meta"
  ],
  "properties": {
    "ok": {
      "type": "boolean",
      "description": "Whether the GHL MCP operation completed successfully."
    },
    "data": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "array",
          "items": {}
        },
        {
          "type": "string"
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        }
      ],
      "description": "Tool-specific GHL or local navigation result when ok is true."
    },
    "meta": {
      "type": "object",
      "description": "Safe execution, routing, and timing metadata.",
      "additionalProperties": true
    },
    "error": {
      "anyOf": [
        {
          "type": "object",
          "additionalProperties": true
        },
        {
          "type": "null"
        }
      ],
      "description": "Safe error details when ok is false; credential values are never returned."
    }
  },
  "description": "Normalized GHL MCP response envelope.",
  "additionalProperties": false
}

Code Examples

cURL

curl -X POST 'https://portal.madpanda3d.com/api/mcp' \
  -H 'Authorization: Bearer mad_live_***' \
  -H 'Content-Type: application/json' \
  -d '{
  "jsonrpc": "2.0",
  "id": "ghl-ghl-create-custom-field-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.ghl_create_custom_field",
    "arguments": {
      "dataType": "TEXT",
      "fieldKey": "fieldKey_example",
      "objectKey": "objectKey_example",
      "parentId": "parentId_123",
      "name": "name_example",
      "options": [],
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "description": "description_example",
      "placeholder": "placeholder_example"
    }
  }
}'

Node.js

const response = await fetch('https://portal.madpanda3d.com/api/mcp', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mad_live_***',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "jsonrpc": "2.0",
  "id": "ghl-ghl-create-custom-field-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.ghl_create_custom_field",
    "arguments": {
      "dataType": "TEXT",
      "fieldKey": "fieldKey_example",
      "objectKey": "objectKey_example",
      "parentId": "parentId_123",
      "name": "name_example",
      "options": [],
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "description": "description_example",
      "placeholder": "placeholder_example"
    }
  }
}),
});
const data = await response.json();
console.log(data);

Python

import requests

url = 'https://portal.madpanda3d.com/api/mcp'
headers = {
    'Authorization': 'Bearer mad_live_***',
    'Content-Type': 'application/json',
}
payload = {
  "jsonrpc": "2.0",
  "id": "ghl-ghl-create-custom-field-example",
  "method": "tools/call",
  "params": {
    "name": "ghl.ghl_create_custom_field",
    "arguments": {
      "dataType": "TEXT",
      "fieldKey": "fieldKey_example",
      "objectKey": "objectKey_example",
      "parentId": "parentId_123",
      "name": "name_example",
      "options": [],
      "tenantId": "tenantId_123",
      "locationId": "locationId_123",
      "description": "description_example",
      "placeholder": "placeholder_example"
    }
  }
}
response = requests.post(url, headers=headers, json=payload, timeout=60)
print(response.json())

Example Responses

200 Success

{
  "ok": true,
  "message": "Tool ghl.ghl_create_custom_field executed successfully.",
  "note": "Response shape varies by MCP tool. Inspect live responses for exact fields."
}

502 Upstream Error

{
  "ok": false,
  "classification": "upstream_http_error",
  "message": "Upstream MCP returned a non-success status."
}