Skip to main content
POST
phone.number.routing.update

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
phoneNumber
string
required

Your owned number, in E.164 format.

Pattern: ^\+[1-9]\d{1,14}$
label
string

New label for this number.

Required string length: 1 - 100
voiceFlowKey
string

Key of a voice route configured for you.

Pattern: ^[A-Za-z0-9_-]{1,128}$
smsRouteKey
string

Key of a text route configured for you.

Pattern: ^[A-Za-z0-9_-]{1,128}$

Response

The result

phoneNumber
string
required

Your owned telephone number.

Pattern: ^\+[1-9]\d{1,14}$
updated
boolean
required

The requested routing change was confirmed.