Preview a new agent schedule

Previews a new schedule for an agent: repeat (daily, weekdays, a weekday, m1/m2/m3 for the first, second or third working day, or vat10), time (HH:MM, the company's time zone) and enabled (on by default), with its next_run_at and the confirmation_token agentSchedule.create needs with the same body and Idempotency-Key within 300 seconds. 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 new agent schedule without persisting changes.

A new schedule: its repeat, its time, and on or off (on unless said).

string
enum
required

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

string
required
^([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
*/*