Flow AgentsVersion: v3
Update Agent Metadata
PATCH/agent-studio/agent/{agentId}
Updates agent metadata such as name, description, and status.
Authorizations
Authorizationstringheaderrequired
Bearer authentication header of the form Bearer <token>, where <token> is your access token.
Scope:
agent-studio.Auth methods:
OAuthPrivate IntegrationToken type:
Sub-Account TokenRequest
Headers
Versionstringrequired
API Version
Available options
v3Example:
v3Path Parameters
agentIdstringrequired
Agent ID whose metadata is being updated
Example:
p1q2r3s4t5u6v7w8x9y0z1a2Query Parameters
sourcestring
Origin channel attributed to this write for auditing (e.g. public_api, internal)
Example:
apiBody
locationIdstringrequired
Location ID for authorization (cannot be updated)
Example:
C2QujeCh8ZnC7al2InWRnamestring
Name of the agent
Example:
Updated Customer Support Agentdescriptionstring
Description of the agent
Example:
Updated AI agent with enhanced customer support capabilitiesstatusstring
Status of the agent
Available options
activeinactivearchivedExample:
activeResponse
Agent metadata updated successfully
successbooleanrequired
Success status
Example:
truemessagestringrequired
Response message
Example:
Agent updated successfullydataobjectrequired
Updated agent or version data