Skip to content
View as Markdown

POST Schedule Campaign​

POST
/campaigns/{id}/schedule

Schedule a campaign for sending. Supports three modes: instant sending (omit scheduled_at), scheduled sending (single datetime), and range-scheduled sending (array of two datetimes for staggered delivery). The campaign must be in draft status. Clears any previously processed emails before scheduling.

Authorizations​

ApplicationPasswords

WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password

Type
API Key (header: Authorization)

Parameters​

Path Parameters

id*

The campaign ID to schedule.

Type
integer
Required

Request Body​

application/json
JSON
{
"scheduled_at": "string",
"sending_type": "schedule"
}

Responses​

Campaign scheduled or sending started.

application/json
JSON
{
"campaign": {
"id": 0,
"title": "string",
"status": "string",
"scheduled_at": "string",
"recipients_count": 0,
"settings": {
},
"created_at": "string",
"updated_at": "string"
},
"message": "string",
"current_timestamp": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI