Change an agent

Makes the change agent.update.preview showed (the same body with its confirmation_token, the same Idempotency-Key) through the agent page's own service, and answers the agent as agent.show does. Switched on, its runs act as the caller. 412 when the agent changed since the preview (compared under its lock); an MCP call is refused 409 agents_stopped while the company has stopped its agents. Requires the agent-runs:action OAuth scope with manage_agent_policies.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The agent's key, from agent.list

Body Params

Confirmed values used to change an agent, including the confirmation token returned by agent.update.preview.

The previewed change with its confirmation token.

boolean

On or off; on needs the plan's agents

string | null

Paused until this time, in the future: ISO 8601 with its offset (2026-12-10T08:00:00+02:00 or ...Z, milliseconds allowed: ...00.000Z), never one read against the clock; null lifts the pause

string
required
length ≤ 4096

The confirmation_token agent.update.preview returned for this body, sent with the same Idempotency-Key within 300 seconds

scope
object | null

What it works on: payment_account_ids, excluded_vendor_ids, chase_after_days (Missing documents only); null clears it

Headers
string
required
length ≤ 191

Required unique key whose request hash and terminal response are stored durably for 24 hours.

Responses

Language
Credentials
OAuth2
Missing 1 required scope
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
*/*