Skip to main content
POST
Purchase a Twilio phone number

Authorizations

X-API-Key
string
header
required

Body

application/json
phoneNumber
string
required

The phone number to purchase in E.164 format

Pattern: ^\+1\d{10}$
Example:

"+14155551234"

friendlyName
string

A friendly name for the phone number

Example:

"My Business Line"

Response

Phone number purchased successfully

id
string
required
phoneNumber
string
required
city
string | null
required
state
string | null
required
country
string
required
ownership
enum<string> | null
required
Available options:
FEATHER,
CLIENT
inboundAgent
object
required
outboundAgents
object[]
required
createdAt
string
required
updatedAt
string
required
smsLinkedAgent
object
squad
object