Skip to main content
POST
Create campaign schedule

Authorizations

api_access_token
string
header
required

All API requests must include the api_access_token header with a valid agent or administrator token.

Body

application/json
campaign_id
integer
required
schedule_type
enum<string>
required
Available options:
once,
recurring
scheduled_at
string<date-time>
required
timezone
string
required
Example:

"Asia/Riyadh"

recurrence_pattern
enum<string>

Required when schedule_type is recurring

Available options:
daily,
weekly,
monthly

Response

Scheduler created

id
integer
campaign_id
integer
schedule_type
enum<string>
Available options:
once,
recurring
scheduled_at
string<date-time>
timezone
string
Example:

"Asia/Riyadh"

recurrence_pattern
string
Example:

"weekly"

created_at
string<date-time>