Retry a campaign's number

Retry a campaign's number

POST/api/v1/sms/registrations/{id}/number

POST /sms/registrations/{id}/number
curl -X POST 'https://www.unitpost.com/api/v1/sms/registrations/123/number' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0' \
  -H 'Content-Type: application/json' \
  -d '{ }'
Response · 200
{
  "object": "sms_number_request",
  "registration_id": "registration_123",
  "number_id": "number_123",
  "created": false,
  "retried": false
}

Bring back the failed local number of an approved 10DLC campaign whose monthly fee is already committed: free, nothing new is bought. A number nothing pays for yet is a purchase: 409 quote_required (Create an SMS purchase quote, product ten_dlc_number). A campaign whose number is live answers it (created: false). Takes an Idempotency-Key. Requires the sms:manage capability.

Parameters2 fields
FieldTypeDescription
idrequiredstring · path—
Idempotency-Keystring · headerAny unique string (1–256 characters, e.g. a UUID). Retrying with the same key and the same body within 24 hours returns the first result instead of sending again; the same key with a different body is `409 invalid_idempotent_request`, and one still in flight is `409 concurrent_idempotent_requests`.
Response · 200 fields5 fields
FieldTypeDescription
objectrequiredstring—
registration_idrequiredstringThe 10DLC campaign (`sreg_…`).
number_idrequiredstringThe number (`snum_…`): read its state on GET /sms/numbers. It leases within minutes.
createdrequiredbooleanFalse when the campaign's number was already live: nothing was requested.
retriedrequiredbooleanA failed number was brought back (the same row, the same committed fee).
200201400401403404409422429502

Search docs and guides

Search the docs and product guides.