Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

Send your API key as Authorization: Bearer YOUR_API_KEY.

Body

application/json

Optional campaign, and number purchase constraints.

campaignId
string

Campaign that will receive the purchased caller ID. Leave it out to keep the number in the agency pool and assign it later.

Example:

"campaign_speed_to_lead_123"

locationId
string

With no campaignId: the client project the number is for. Must be one of the agency's projects. Ignored when campaignId is set, because the campaign names its project.

Minimum string length: 1
Example:

"loc_9f7a123"

areaCode
integer

Three-digit area code preference.

Required range: 200 <= x <= 999
Example:

415

countryCode
enum<string>

Country for the new phone number.

Available options:
US,
CA
Example:

"US"

tollFree
boolean

Request a toll-free number.

Example:

false

phoneNumber
string

Specific E.164 number selected from search.

Pattern: ^\+\d{10,15}$
Example:

"+14155559876"

Response

Phone number purchased, and assigned when a campaign was named.

success
boolean
required
phoneNumber
object
required