SMS campaigns

Create an SMS campaign

Create an SMS campaign as a draft: a published SMS template sent to a segment. Omit sender_id for automatic routing (the best live sender per recipient), or pass an snum_… number to send from it. A draft always saves, even if it isn't ready yet; only an id that doesn't exist in this workspace returns 422. scheduled_at saves a send time ("Send at") that a send with no scheduled_at uses. Check readiness with Validate an SMS campaign, then send it with Send an SMS campaign. Requires the campaigns:write capability.

post/sms/campaigns

Request

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

Request body

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

Response

Created.

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.