Update Number

put

{protocol}://{server}{basePath}/accounts/{accountId}/phone-numbers/{phoneNumberId}

This API requires the Account Administrator role.

Update phone number by using accountId and phoneNumberId. The possible field you can update is displayName.

The following field must be unique otherwise a HTTP 409 Conflcit will be returned:

phoneNumber

Will trigger asynchronous updates, the status of which should be monitored via /phone-numbers/{phoneNumberId}.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

^[a-zA-Z]{6}$

The unique 6 character internal id that represents the customer account.

phoneNumberId

string

required

length between 36 and 36

^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

The unique 36 character internal id that represents the phone number.

Body Params

PhoneNumber Update request.

displayName

string

length ≤ 255

Domestic format version of the phone number or any suitable name that will identify the number easily.

isCallingPartyNumber

boolean

Indicates whether the number is caller Id.

preferredMediaLocation

string

length between 1 and 7

Preferred media location set by tenant instead of default coming from CPaaS.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

202Accepted

400Constraint Violation

401Unauthorized

403Forbidden

404Not Found

409Conflict

500All other application errors