Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Body

application/json
inbound_objective
string | null
status
enum<string>
Available options:
active,
inactive,
awaiting_verification,
in_review,
declined,
cancelled
country
string
forward_to
string | null
call_routing
enum<string>
Available options:
agent,
forward
answer_texts
boolean
text_back_missed_calls
boolean
text_new_leads
boolean

Response

Phone number provisioned

id
string
required
object
string
required
e164
string | null
required
status
enum<string>
required
Available options:
active,
inactive,
awaiting_verification,
in_review,
declined,
cancelled
country
string
required
inbound_objective
string | null
required
forward_to
string | null
required
call_routing
enum<string>
required
Available options:
agent,
forward
verification_url
string | null
required
review_note
string | null
required
texting
enum<string>
required
Available options:
off,
registering,
active,
unsupported
sms_registration_url
string | null
required
answer_texts
boolean
required
text_back_missed_calls
boolean
required
text_new_leads
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
monthly_credits
integer
required