Skip to main content
PATCH
Update agent

Authorizations

X-API-Key
string
header
required

Your organization API key. See Authentication.

Headers

Idempotency-Key
string

Optional retry key. Check X-Idempotency-Applied before relying on replay protection.

Required string length: 1 - 255

Path Parameters

agent_id
string
required

ID of the agent.

Minimum string length: 1

Body

application/json
name
string

Updated display name.

description
string

Updated free-text description.

status
enum<string>

Lifecycle status. Paused and archived agents cannot start new runs.

Available options:
active,
paused,
archived
is_active
boolean
deprecated

Deprecated; use status. false pauses the agent and true activates it.

cron_expressions
string[]

Replacement schedule as cron expressions.

schedule_description
string

Human-readable schedule label.

emails
string[]

Notification email recipients.

slack_channel_id
string | null

Slack channel id for notifications, or null to clear.

owner_user_id
string | null

Prefixed usr_ id of the owner to assign, or null to clear.

reviewer_user_id
string | null

The reviewer user id. Native tool approval requests go to this reviewer. If no reviewer is assigned, requests go to the owner.

Legal entities this agent works on. Replaces the current list, so send the full list as [{ "id": "le_…" }]. name is ignored.

Maximum array length: 100
sources
object[]

Sources this agent works on. Replaces the current list, so send the full list as [{ "id": "…" }]. name is ignored.

Maximum array length: 100
enabled_mcp_connection_ids
string<uuid>[]

MCP connections that the agent can use. Replaces the list; send [] to clear it.

Maximum array length: 50

Response

The request succeeded.

data
object
required