Skip to main content
POST
Create Schedule

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

CreateScheduleRequestData

name
string
required
Maximum string length: 255
message
string
required
scheduled_at
string<date-time>
required
completed_at
string<date-time> | null
published_at
string<date-time> | null
status
enum<integer> | null
Available options:
0,
1,
2
notifications
boolean
default:false
components
ScheduleComponentRequestData · object[] | null
meta
object | null

Response

Schedule

data
Schedule · object
required
included
(Component · object | Update · object)[]