Campaigns

Cancel a campaign

Cancel a draft, scheduled, or sending campaign. Cancelation is terminal — the campaign can't be restarted afterwards. Messages already sent to recipients are not recalled. If you only want to stop temporarily, use Pause a campaign instead. Requires the campaigns:send capability.

post/email/campaigns/{id}/cancel

Request

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

Response

The canceled 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.