v2

latestOpenAPI 3.1.02026-08-075421692.0 MB
SMS

Start a carrier registration

Starts the US carrier registration that a number needs before SMS delivers: 10DLC (standard company or sole-proprietor) or toll-free verification. 10DLC needs brand + campaign; toll-free needs tollFree. Approval is asynchronous; poll GET /v1/sms/registrations/{id} (sole-prop registrations first need the OTP step: a code is texted to the brand's mobile number, submit it via /verify-otp).

Already have an approved registration? Add another number to it with POST /v1/phone-numbers/{id}/sms/reuse-registration instead of registering (and paying the carrier brand fee) again.

Rather have your client fill in the legal business details? Create a share link with POST /v1/sms/registrations/share.

post/v1/sms/registrations

Request body

registrationType'standard_10dlc' | 'sole_prop_10dlc' | 'toll_free' required
phoneNumbersstring[]

Your numbers this registration covers. When omitted or empty on a 10DLC registration, defaults to your active SMS-enabled US local numbers not already covered by another registration.

messagingBrandNamestring

DBA / trade name used to brand message content (samples and auto-replies) when it differs from the legal name, e.g. a sole proprietor texting under a business name. The legal brand.displayName is still what the carrier vets.

wizardValuesobject

Raw dashboard-wizard answers, stored only to prefill edit-and-resubmit. API integrators can omit.

resubmitRequestIdstring

Resubmit a registration that was returned for changes — updates it in place instead of creating a new one.

Response

Registration submitted.

registrationIdstring
status'pending'
awaitingOtpboolean

True for sole-prop 10DLC: an OTP was texted to the brand's mobile; submit it via /verify-otp.