HighLevel: Update Agent Metadata

← Agent studio operations · Get started

Operation gohighlevel.updateagentmetadata

Provider route: PATCH /agent-studio/agent/{agentId}. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["agentStudio"]["updateAgentMetadata"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.agentStudio.updateAgentMetadata(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.agent_studio.update_agent_metadata(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.agentId	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.source	string	Optional
body	Model	Required within parent	Expand Update Agent Metadata — request body — body

Referenced models: Update Agent Metadata — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Update Agent Metadata — response body

Referenced models: Update Agent Metadata — response body

Schemas

Update Agent Metadata — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	object	Required within parent	Updated agent or version data
message	string	Required within parent	Response message
success	boolean	Required within parent	Success status

Update Agent Metadata — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
description	string	Optional	Description of the agent
locationId	string	Required within parent	Location ID for authorization (cannot be updated)
name	string	Optional	Name of the agent
status	string	Optional	Status of the agent One of: active, inactive, archived

Policy, approvals and errors

SDK function policy ID: gohighlevel.updateagentmetadata. Catalog operation: updateAgentMetadata. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["agent-studio.write"]

Pinned headers: {"Version": "v3"}

Official provider source