Skip to main content
POST
Purchase Phone Number

Headers

string
required
API key used for authenticating requests to the API.
string
required
Workspace identifier for the API.

Request Body

string
required
Country code for the phone number (e.g., “US”, “CA”).
string
required
Type of phone number. Options: “local”, “tollFree”, “mobile”.
string
required
The specific phone number to purchase in E.164 format.
string
Address SID for regulatory compliance (required for some countries).
string
Coupon code for a discount.

Response Fields

boolean
Whether the purchase was successful.
object
The purchased phone number details.
string
Unique identifier for the phone number record.
string
The purchased phone number in E.164 format.
string
Country code.
string
Phone number type.