v10

latestSwagger 2.02026-07-13203270.7 KB

Manage purchased phone numbers

Updates the capabilities of a phone number.

patch/phoneNumbers/{phoneNumber}/capabilities

Path parameters

phoneNumberstring required

The phone number id in E.164 format. The leading plus can be either + or encoded as %2B, e.g. +11234567890.

Query parameters

api-versionstring required

Version of API to invoke

Response

The service has accepted the request and will start processing later. It will return 'Accepted' immediately and include an 'Operation-Location' and 'Location' headers. Client side should further query the operation status using the URL specified in 'Operation-Location' header. When operation completes successfully query final result using URL specified in 'Location' header.

idstring required

The id of the phone number, e.g. 11234567890.

phoneNumberstring required

String of the E.164 format of the phone number, e.g. +11234567890.

countryCodestring required

The ISO 3166-2 code of the phone number's country, e.g. US.

phoneNumberType'geographic' | 'tollFree' | 'mobile' required

The phone number's type, e.g. geographic, tollFree, mobile.

assignmentType'person' | 'application' required

The assignment type of the phone number. A phone number can be assigned to a person, or to an application.

purchaseDatestring date-time required

The date and time that the phone number was purchased.