Skip to main content

Campaigns, runs & send

Campaign CRUD, run history, and the send endpoint (queues delivery like “Send now” in the app).

GET /v1/campaigns

List campaigns Lists campaigns for the user.

Examples

200 — OK

cURL

POST /v1/campaigns

Create campaign schedule_type: manual | scheduled_once | recurring | recurring_new_contacts. For scheduled_once set scheduled_at (ISO 8601). For recurring set recurrence_interval (≥1) and recurrence_unit: day | week | month.

Request body — Body

Examples

201 — Created

cURL

GET /v1/campaigns/{id}

Get campaign Fetch one campaign.

Examples

200 — OK

cURL

PATCH /v1/campaigns/{id}

Update campaign Partial update.

Request body — Body

Examples

200 — OK

cURL

DELETE /v1/campaigns/{id}

Delete campaign Deletes the campaign.

Examples

200 — OK

cURL

GET /v1/campaigns/{id}/runs

List campaign runs Runs for the campaign, newest first. Items include aggregate counts from mail logs: total, sent, failed, pending, etc.

Examples

200 — OK

cURL

POST /v1/campaigns/{id}/send

Send campaign Queues delivery to the segment audience. Requires segment and template. JSON aliases: sendNow, senderAccountIds. Omit sender_account_ids for default account selection.

Request body — Body

Examples

200 — OK

cURL