SMS

Cancel or reschedule an SMS

Cancel a scheduled or queued SMS (its reserved credit is refunded), or move a scheduled one to a new send time with scheduled_at. Send exactly one of cancel: true or scheduled_at. Only a text the carrier has not been handed can be changed — afterwards this returns 409, as it does for a text that belongs to a campaign. Quiet hours still apply to the new time. Look up the current state first with Retrieve an SMS message. Requires the sms:send capability.

patch/sms/{id}

Request

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

Path parameters

idstring required

The SMS message id (sms_…).

Request body

canceltrue

Cancel a queued or scheduled text. Its reserved credit is refunded.

scheduled_atstring date-time

Move a scheduled text to this future ISO-8601 time.

Response

The updated SMS message.

object'sms' required
idstring required
tostring required
fromstring nullable required
direction'outbound' | 'inbound' required
status'queued' | 'scheduled' | 'sending' | 'sent' | 'delivered' | 'failed' | 'suppressed' | 'canceled' | 'received' required
type'transactional' | 'marketing' required
bodystring nullable required
segmentsinteger required
countrystring nullable required
scheduled_atstring nullable required
last_errorstring nullable required

Legacy free-text error. Prefer error.code.

created_atstring required

Changes

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