Skip to main content
POST
/
api
/
v1
/
twilio
/
purchase
Purchase a Twilio phone number
curl --request POST \
  --url https://prod.featherhq.com/api/v1/twilio/purchase \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "phoneNumber": "+14155551234",
  "friendlyName": "My Business Line"
}'
{
  "id": "<string>",
  "phoneNumber": "<string>",
  "city": "<string>",
  "state": "<string>",
  "country": "<string>",
  "ownership": "FEATHER",
  "inboundAgent": {
    "agentId": "<string>",
    "agentName": "<string>"
  },
  "outboundAgents": [
    {
      "agentId": "<string>",
      "agentName": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
phoneNumber
string
required

The phone number to purchase in E.164 format

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