Amazon Chime
API Reference (API Version 2018-05-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.


Updates phone number details, such as product type, for the specified phone number ID. For toll-free numbers, you can use only the Amazon Chime Voice Connector product type.

Request Syntax

POST /phone-numbers/phoneNumberId HTTP/1.1 Content-type: application/json { "ProductType": "string" }

URI Request Parameters

The request requires the following URI parameters.


The phone number ID.

Request Body

The request accepts the following data in JSON format.


The product type.

Type: String

Valid Values: BusinessCalling | VoiceConnector

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "PhoneNumber": { "Associations": [ { "AssociatedTimestamp": number, "Name": "string", "Value": "string" } ], "Capabilities": { "InboundCall": boolean, "InboundMMS": boolean, "InboundSMS": boolean, "OutboundCall": boolean, "OutboundMMS": boolean, "OutboundSMS": boolean }, "CreatedTimestamp": number, "DeletionTimestamp": number, "E164PhoneNumber": "string", "PhoneNumberId": "string", "ProductType": "string", "Status": "string", "Type": "string", "UpdatedTimestamp": number } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The updated phone number details.

Type: PhoneNumber object


For information about the errors that are common to all actions, see Common Errors.


The input parameters don't match the service's restrictions.

HTTP Status Code: 400


The client is permanently forbidden from making the request. For example, when a user tries to create an account from an unsupported Region.

HTTP Status Code: 403


One or more of the resources in the request does not exist in the system.

HTTP Status Code: 404


The service encountered an unexpected error.

HTTP Status Code: 500


The service is currently unavailable.

HTTP Status Code: 503


The client exceeded its request rate limit.

HTTP Status Code: 429


The client is not currently authorized to make the request.

HTTP Status Code: 401

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: