PATCH/v1/agents/{agent_id}

Update an agent

Updates an existing agent's name, enabled state, or conversation settings. Send only the fields you want to change; all body properties are optional.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
agent_idstringrequired
The unique identifier of the agent to update.

Partial agent update. All fields are optional; include only the values you want to change.

namestringoptional
A human-readable name for the agent.
enabledbooleanoptional
Whether the agent is enabled.
conversation_configobjectoptional
Conversation settings to update.

1 status code
200Returns the updated agent object.

Error handling

The agent_id path parameter must identify an existing agent. All body fields are optional, and conversation_config.language must be one of en, es, fr, or de when supplied.