Skip to main content
POST
phone.number.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 rented phone number.

Required string length: 1 - 16
Pattern: ^\+[1-9]\d{5,14}$
alias
string

Your display name for this number.

Required string length: 1 - 100
flowRef
string

The ref returned by an owned routing flow.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
complianceRef
string

The ref returned by an owned number compliance application.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
callerNameLookup
boolean

Enable paid incoming caller-name lookup, or disable it.

callerName
string

Requested outbound caller display name, up to 15 characters.

Required string length: 1 - 15

Response

The result

updated
boolean
required

Number settings update was accepted.