Skip to main content
POST
/
v1
/
communication
/
phone-numbers
Register an org phone number
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/communication/phone-numbers \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "phone_e164": "<string>",
  "vendor": "twilio",
  "capabilities": [],
  "vendor_metadata": {},
  "integration_connection_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "phone_e164": "<string>",
  "vendor": "twilio",
  "capabilities": [],
  "vendor_metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Body

application/json
phone_e164
string
required
Required string length: 2 - 20
vendor
enum<string>
required
Available options:
twilio
vendor_mode
enum<string>
required
Available options:
platform,
byo
capabilities
enum<string>[]
Available options:
sms,
voice
vendor_metadata
Vendor Metadata · object
integration_connection_id
string<uuid> | null

BYOT only. Pin the new Sender to a specific connected Twilio integration. Required when the org has more than one connected Twilio integration; when omitted, the service auto-discovers the org's single connected integration and 422s on ambiguity.

Response

Successful Response

id
string<uuid>
required
organization_id
string<uuid>
required
phone_e164
string
required
vendor
enum<string>
required
Available options:
twilio
vendor_mode
enum<string>
required
Available options:
platform,
byo
capabilities
enum<string>[]
required
Available options:
sms,
voice
vendor_metadata
Vendor Metadata · object
required
status
enum<string>
required
Available options:
active,
paused,
retired
created_at
string<date-time>
required
updated_at
string<date-time>
required