Skip to main content
POST
Open a hosted-messaging order

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json

Fields required to open a new hosted-messaging order.

phoneNumber
string
required

E.164 number to text-enable (e.g. +14155550123). Its voice service stays with the current carrier.

voiceCarrier
string
required

Carrier of record that keeps voice service for the number (informational).

Required string length: 1 - 200
numberType
enum<string>
required

Number class the hosting carrier will text-enable.

Available options:
landline,
tollfree,
mobile
inboundRoute
object
required

Delivery target for inbound SMS received on a hosted (text-enabled) number once the order is active. Inbound only — no outbound (MT) path is created.

businessName
string

Business / brand name on the carrier-of-record account (used for LOA matching).

Required string length: 1 - 200

Response

201 - application/json

The created hosted-messaging order (status draft).

data
object

A hosted-messaging ("text-enable") order stored for the organization.

meta
object