SMS campaigns

Cancel an SMS campaign

Cancel a scheduled, sending or paused SMS campaign. Messages already handed to the carrier are not recalled. Requires the campaigns:send capability.

post/sms/campaigns/{id}/cancel

Request

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

Response

The SMS campaign, now canceled; its queued texts are canceled and refunded.

object'sms_campaign' required
idstring required
namestring required
status'draft' | 'scheduled' | 'sending' | 'paused' | 'sent' | 'canceled' | 'failed' required
type'marketing' | 'transactional' required
template_idstring required
segment_idstring required
sender_idstring nullable required
topic_idstring nullable required
routing'automatic' | 'fixed' | 'pool' required
scheduled_atstring nullable required
recipient_countnumber required
variable_fallbacksobject required
excluded_contact_idsstring[] required
started_atstring nullable required
completed_atstring nullable required
canceled_atstring nullable required
created_atstring required
updated_atstring required

Changes

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