Skip to main content

​
Properties

​
Agent | null
Type: Agent
​
boolean | null
​
boolean | null
​
string | null
​
number | null
​
string | null
​
NotifyOn | null
Type: NotifyOn
​
string
required
Organization ID (prefix: org-)
​
string | null
VM platform for sessions spawned by this schedule (e.g. ‘windows’). When omitted, the platform is left unchanged. Value must match a platform configured for the organization (case-insensitive); unknown values are rejected with a 400 that lists the available platform labels.
​
string | null
​
string | null
​
string | null
Set the user ID that this schedule will run as. Requires ImpersonateOrgSessions permission. Setting to null reverts to the default bot user. Omitting the field leaves the current identity unchanged.
​
string
required
Schedule ID (prefix: sched-)
​
ScheduleType | null
Type: ScheduleType
​
string | null
​
string | null
​
string | null
​
string[] | null
​
string | null