Skip to main content
POST
sms.registration.submit

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
business
object
required

The business that sends the texts.

contact
object
required

A person authorised to act for the business.

campaign
object
required

What will be sent and how people opted in.

volume
enum<string>
default:low

low: under about 6,000 texts a day (cheaper, faster). Default low.

Available options:
low,
standard

Response

The result

status
enum<string>
required

Where the registration stands.

Available options:
not_submitted,
brand_pending,
brand_approved,
campaign_pending,
approved,
failed
nextStep
string
required

What to do next, in plain words.