SMS campaigns

Update an SMS campaign

Edit a draft SMS campaign: name, template, segment, sender (null returns to automatic routing), topic, excluded_contact_ids, variable_fallbacks and the saved send time scheduled_at (null clears it). Once the campaign has been sent or scheduled, or while it is archived, edits return 409. Pass { "archived": true | false } to archive or restore it (this takes precedence over other fields). Requires the campaigns:write capability.

patch/sms/campaigns/{id}

Request

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

Request body

archivedboolean
namestring
template_idstring
segment_idstring
sender_idstring nullable
topic_idstring nullable
excluded_contact_idsstring[]
variable_fallbacksobject
scheduled_atstring date-time nullable

Response

The updated SMS campaign.

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.