Preview a change to an agent schedule

Previews a change to one of an agent's schedules (schedule, an id from agent.show; repeat, time, enabled, each optional, at least one): before, after with its next_run_at, and the confirmation_token agentSchedule.update needs with the same body and Idempotency-Key within 300 seconds. 404 agent_schedule_not_found for a schedule of another agent. 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

string
required

The schedule's id, from agent.show

Body Params

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

A change to a schedule: its repeat, its time, or on or off, at least one;
it keeps what it leaves out.

string
enum

daily, weekdays, a weekday, m1/m2/m3 (first, second or third working day) or vat10 (10 days before the VAT deadline)

string
^([01]\d|2[0-3]):[0-5]\d$

HH:MM, in the company's time zone

boolean

On or off (a new one is on)

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