Campaigns

Pause a campaign

Pause a scheduled or sending campaign. A paused send stops cleanly between recipients — already-sent messages are untouched, and no partial email is ever produced. Continue where it left off with Resume a campaign, or stop it for good with Cancel a campaign. Requires the campaigns:send capability.

post/email/campaigns/{id}/pause

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/email/campaigns/{id}/pause
  • Auth: HTTP bearer

Response

The paused campaign.

object'campaign' required
idstring required
namestring required
template_idstring required
segment_idstring required
topic_idstring nullable required
fromstring required
subjectstring nullable required
preview_textstring nullable required
open_trackingboolean nullable required
click_trackingboolean nullable required
status'draft' | 'scheduled' | 'sending' | 'paused' | 'sent' | 'canceled' | 'failed' required
scheduled_atstring nullable required
variable_fallbacksobject required
excluded_contact_idsstring[] required
total_recipientsnumber required
sent_countnumber required
failed_countnumber required
created_atstring required
updated_atstring required

Changes

No recorded changes to this operation across all 1 revision of this API.