Skip to main content
POST
Buy a phone number

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Body

application/json
number
string
required

The exact E.164 number returned by GET /phone-numbers/available.

country
string
required

ISO-2 country code, e.g. DE.

type
enum<string>
default:local
Available options:
local,
mobile,
national
assistant_id
string<uuid> | null

Optionally assign an assistant right away.

Response

A pending phone number and the Stripe Checkout URL required to activate it.

data
object
required