ghl_agent_studio_update_metadata
Updates an agent's name, description, and status using a sub-account token, so you can keep GoHighLevel Agent Studio metadata accurate.
Instructions
Update Agent Metadata Updates agent metadata such as name, description, and status. Endpoint: PATCH /agent-studio/agent/{agentId} (Version header: v3; source: v3/agent-studio-v3.json) Requires a Sub-Account (location) token. OAuth scopes: agent-studio.write
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": {
"agentId": "<agentId>",
"body": "<body>"
},
"name": "ghl_agent_studio_update_metadata"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Request body (schema carried verbatim from the official OpenAPI spec). | |
| source | No | Origin channel attributed to this write for auditing (e.g. public_api, internal) | |
| agentId | Yes | Agent ID whose metadata is being updated |