Resume a campaign
POST/api/v1/email/campaigns/{id}/resume
curl -X POST 'https://www.unitpost.com/api/v1/email/campaigns/cmp_123/resume' \
-H 'Authorization: Bearer YOUR_API_KEY' \
-H 'User-Agent: my-app/1.0'{
"object": "campaign",
"id": "id_123",
"name": "Example",
"template_id": "template_123",
"segment_id": "segment_123",
"topic_id": "topic_123",
"from": "you@yourdomain.com",
"subject": "Welcome to Acme",
"preview_text": "string",
"open_tracking": false,
"click_tracking": false,
"status": "draft",
"scheduled_at": "2026-01-01T00:00:00.000Z",
"variable_fallbacks": {},
"excluded_contact_ids": [
"string"
],
"total_recipients": 1,
"projected_recipients": {
"total": 1,
"reachable": 0,
"skipped": 0
},
"sent_count": 1,
"failed_count": 1,
"pause_reason": {
"code": "user",
"message": "string",
"metric": "hard_bounce_rate",
"value": 0,
"threshold": 0,
"sample": {
"events": 0,
"of": 0
},
"window": {
"since": "string"
},
"decided_by": "floor",
"resume": "self_serve",
"paused_at": "2026-01-01T00:00:00.000Z"
},
"created_at": "2026-01-01T00:00:00.000Z",
"updated_at": "2026-01-01T00:00:00.000Z"
}Resume a paused campaign. Sending continues with the recipients that hadn't been reached yet — only them: contacts who joined the segment after the campaign started are not added, and anyone already delivered to is skipped, so nobody receives the campaign twice. After an automatic quality pause (pause_reason.code hard_bounce_rate, complaint_rate or quality_review) the quality check measures only sends made after the resume. A campaign whose scheduled_at is still in the future waits for it; otherwise it sends immediately. Resume runs the same checks as Send a campaign and answers with the same errors; the campaign stays paused when one fails. Pause a send with Pause a campaign. Requires the campaigns:send capability.
Parameters1 field
| Field | Type | Description |
|---|---|---|
idrequired | string · path | — |
Response · 200 fields22 fields
| Field | Type | Description |
|---|---|---|
objectrequired | string | — |
idrequired | string | — |
namerequired | string | — |
template_idrequired | string | — |
segment_idrequired | string | — |
topic_idrequired | string | null | — |
fromrequired | string | — |
subjectrequired | string | null | — |
preview_textrequired | string | null | — |
open_trackingrequired | boolean | null | — |
click_trackingrequired | boolean | null | — |
statusrequired | enumdraft | scheduled | sending | paused | sent | canceled | failed | — |
scheduled_atrequired | string | null | — |
variable_fallbacksrequired | object | — |
excluded_contact_idsrequired | string[] | — |
total_recipientsrequired | number | Recipients the engine admitted when the campaign started sending. 0 while it is `draft` or `scheduled`: read `projected_recipients`, or `sendable` from validate. |
projected_recipients | object | null | The audience counted when the campaign was sent or scheduled: `total` segment members, `reachable` who will get it, `skipped` (unsubscribed, suppressed, excluded). Null for a draft that was never sent: read validate. Read-only. |
sent_countrequired | number | — |
failed_countrequired | number | — |
pause_reasonrequired | object | null | — |
created_atrequired | string | — |
updated_atrequired | string | — |