Preview a change to an agent

Previews switching an agent on or off (enabled), pausing it until a time (paused_until, null lifts it) or setting its scope (payment_account_ids, excluded_vendor_ids, and chase_after_days for Missing documents; null clears it): before and after, acts_as_you (switched on, its runs act as the caller) and the confirmation_token agent.update needs with the same body and Idempotency-Key within 300 seconds. An agent's policy and a made agent's ceiling are set in Cybooks only (max_mode is a 422). 403 agents_premium to switch one on without the plan's agents; 404 agent_not_found. Writes nothing. 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

Proposed values used to preview a change to an agent without persisting changes.

An agent's change: on or off, a pause until a time, its scope. Never its
policy or a made agent's ceiling (set in Cybooks only).

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

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 operation-specific request key. This requirement does not imply durable public API response replay.

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
*/*