Skip to main content

Update Object Record

Immutable Catalog Entry

This descriptor comes from the active versioned Portal catalog.

WRITEghl.update_object_record
  • Contract tier: agent_ready
  • Risk: write
  • Catalog version: 2026-07-12.2
  • Descriptor hash: 729d4e58a1c43b70dacd488033de1db7cea1dbc209cc1459fe59b463b0d4bc1e

Update an existing record in a custom or standard object GHL category: App Marketplace. This writes to GoHighLevel and may change account data.

Request Body

{
"jsonrpc": "2.0",
"id": "ghl-update-object-record-example",
"method": "tools/call",
"params": {
"name": "ghl.update_object_record",
"arguments": {
"schemaKey": "schemaKey_example",
"recordId": "recordId_123",
"owner": [],
"tenantId": "tenantId_123",
"followers": [],
"locationId": "locationId_123",
"properties": {},
"strictTenant": false,
"includeRecordDetails": false
}
}
}

Arguments Schema

{
"type": "object",
"required": [
"schemaKey",
"recordId"
],
"properties": {
"owner": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1,
"description": "Updated array of user IDs who own this record"
},
"recordId": {
"type": "string",
"description": "ID of the record to update"
},
"tenantId": {
"type": "string",
"description": "Tenant ID from list_tenants."
},
"followers": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 10,
"description": "Updated array of user IDs who follow this record"
},
"schemaKey": {
"type": "string",
"description": "Schema key of the object"
},
"locationId": {
"type": "string",
"description": "Location ID (uses default if not provided)"
},
"properties": {
"type": "object",
"description": "Updated record properties as key-value pairs"
},
"strictTenant": {
"type": "boolean",
"default": true,
"description": "Require tenantId to match locationId routing (default: true)."
},
"includeRecordDetails": {
"type": "boolean",
"description": "Defaults to false. When false, returns record metadata and property keys only, not full custom object record property values."
}
}
}

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 -X POST 'https://portal.madpanda3d.com/api/mcp' \
-H 'Authorization: Bearer mad_live_***' \
-H 'Content-Type: application/json' \
-d '{
"jsonrpc": "2.0",
"id": "ghl-update-object-record-example",
"method": "tools/call",
"params": {
"name": "ghl.update_object_record",
"arguments": {
"schemaKey": "schemaKey_example",
"recordId": "recordId_123",
"owner": [],
"tenantId": "tenantId_123",
"followers": [],
"locationId": "locationId_123",
"properties": {},
"strictTenant": false,
"includeRecordDetails": false
}
}
}'

Example Responses

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