Endpoints
Campaigns
Broadcast campaigns created in the app: status, results and sending.
Paths are relative to the base URL. Each card lists the permission the call needs and every parameter, with its type and limits.
GET
/campaignsList campaigns, newest first.
Permission: campaigns
Paginated
Query parameters
- statusoptionalenum
Campaign status.
Allowed values:
draftscheduledsendingcompletedfailed
GET
/campaigns/:idRetrieve a campaign with its delivery stats.
Permission: campaigns
Path parameters
- idrequiredstring
Campaign ID.
POST
/campaigns/:id/sendSend a draft, scheduled or failed campaign now, or schedule it.
Permission: campaigns
Path parameters
- idrequiredstring
Campaign ID.
JSON body
- send_atoptionalstring (ISO 8601 date-time with offset) | null
Schedule for this time. Omit or null to send now.
- Sending now answers 202 and runs in the background; campaign.completed fires when it finishes. Scheduling answers 200.
- 402 insufficient_credits when the workspace cannot pay for the send; 409 for a campaign that is already sending or completed.