**End of support notice**: On February 20, 2026, AWS will end support for the Amazon Chime service. After February 20, 2026, you will no longer be able to access the Amazon Chime console or Amazon Chime application resources. For more information, visit the [blog post](https://aws.amazon.com/blogs/messaging-and-targeting/update-on-support-for-amazon-chime/). **Note:** This does not impact the availability of the [Amazon Chime SDK service](https://aws.amazon.com/chime/chime-sdk/). # UpdatePhoneNumber Updates phone number details, such as product type or calling name, for the specified phone number ID. You can update one phone number detail at a time. For example, you can update either the product type or the calling name in one action. For toll-free numbers, you cannot use the Amazon Chime Business Calling product type. For numbers outside the U.S., you must use the Amazon Chime SIP Media Application Dial-In product type. Updates to outbound calling names can take 72 hours to complete. Pending updates to outbound calling names must be complete before you can request another update. ## Request Syntax ``` POST /phone-numbers/phoneNumberId HTTP/1.1 Content-type: application/json { "CallingName": "string", "ProductType": "string" } ``` ## URI Request Parameters The request uses the following URI parameters. ** [phoneNumberId](#API_UpdatePhoneNumber_RequestSyntax) ** The phone number ID. Required: Yes ## Request Body The request accepts the following data in JSON format. ** [CallingName](#API_UpdatePhoneNumber_RequestSyntax) ** The outbound calling name associated with the phone number. Type: String Pattern: `^$|^[a-zA-Z0-9 ]{2,15}$` Required: No ** [ProductType](#API_UpdatePhoneNumber_RequestSyntax) ** The product type. Type: String Valid Values: `BusinessCalling | VoiceConnector | SipMediaApplicationDialIn` Required: No ## Response Syntax ``` HTTP/1.1 200 Content-type: application/json { "PhoneNumber": { "Associations": [ { "AssociatedTimestamp": "string", "Name": "string", "Value": "string" } ], "CallingName": "string", "CallingNameStatus": "string", "Capabilities": { "InboundCall": boolean, "InboundMMS": boolean, "InboundSMS": boolean, "OutboundCall": boolean, "OutboundMMS": boolean, "OutboundSMS": boolean }, "Country": "string", "CreatedTimestamp": "string", "DeletionTimestamp": "string", "E164PhoneNumber": "string", "PhoneNumberId": "string", "ProductType": "string", "Status": "string", "Type": "string", "UpdatedTimestamp": "string" } } ``` ## 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. ** [PhoneNumber](#API_UpdatePhoneNumber_ResponseSyntax) ** The updated phone number details. Type: [PhoneNumber](API_PhoneNumber.md) object ## Errors For information about the errors that are common to all actions, see [Common Error Types](CommonErrors.md). ** BadRequestException ** The input parameters don't match the service's restrictions. HTTP Status Code: 400 ** ConflictException ** The request could not be processed because of conflict in the current state of the resource. HTTP Status Code: 409 ** ForbiddenException ** The client is permanently forbidden from making the request. HTTP Status Code: 403 ** NotFoundException ** One or more of the resources in the request does not exist in the system. HTTP Status Code: 404 ** ServiceFailureException ** The service encountered an unexpected error. HTTP Status Code: 500 ** ServiceUnavailableException ** The service is currently unavailable. HTTP Status Code: 503 ** ThrottledClientException ** The client exceeded its request rate limit. HTTP Status Code: 429 ** UnauthorizedClientException ** The client is not currently authorized to make the request. HTTP Status Code: 401 ## Examples In the following example or examples, the Authorization header contents( `AUTHPARAMS` ) must be replaced with an AWS Signature Version 4 signature. For more information about creating these signatures, see [Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html) in the *AWS General Reference*. You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the [AWS Command Line Interface (AWS CLI)](http://aws.amazon.com/cli/) or one of the [AWS SDKs](http://aws.amazon.com/tools/) to make requests to AWS, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself. ### Example: Update Product Type This example updates the product type for the specified phone number. #### Sample Request ``` POST /phone-numbers/%2B12065550100 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191029T182530Z Authorization: AUTHPARAMS Content-Length: 34 {"ProductType": "BusinessCalling"} ``` #### Sample Response ``` HTTP/1.1 200 OK x-amzn-RequestId: 885b5970-6640-46e9-8b59-3d77be15a4f5 Content-Type: application/json Content-Length: 484 Date: Tue, 29 Oct 2019 18:25:29 GMT Connection: keep-alive {"PhoneNumber":{"Associations":[],"CallingName":"phonenumber1","CallingNameStatus":"UpdateSucceeded","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-12T22:10:20.521Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550100","PhoneNumberId":"%2B12065550100","ProductType":"BusinessCalling","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-10-29T18:25:30.392Z"}} ``` ### Example: Update Outbound Calling Name This example updates the outbound calling name for the specified phone number. #### Sample Request ``` POST /phone-numbers/%2B12065550100 HTTP/1.1 Host: service.chime.aws.amazon.com Accept-Encoding: identity User-Agent: aws-cli/1.16.170 Python/3.6.0 Windows/10 botocore/1.12.160 X-Amz-Date: 20191029T182817Z Authorization: AUTHPARAMS Content-Length: 28 {"CallingName": "phonenumber2"} ``` #### Sample Response ``` HTTP/1.1 200 OK x-amzn-RequestId: d25cff84-0a51-4126-b4e9-9460535fcd68 Content-Type: application/json Content-Length: 478 Date: Tue, 29 Oct 2019 18:28:17 GMT Connection: keep-alive {"PhoneNumber":{"Associations":[],"CallingName":"phonenumber2","CallingNameStatus":"UpdateSucceeded","Capabilities":{"InboundCall":true,"InboundMMS":true,"InboundSMS":true,"OutboundCall":true,"OutboundMMS":true,"OutboundSMS":true},"CreatedTimestamp":"2019-08-09T21:35:21.445Z","DeletionTimestamp":null,"E164PhoneNumber":"+12065550100","PhoneNumberId":"%2B12065550100","ProductType":"BusinessCalling","Status":"Unassigned","Type":"Local","UpdatedTimestamp":"2019-10-29T02:40:47.748Z"}} ``` ## See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: + [AWS Command Line Interface V2](https://docs.aws.amazon.com/goto/cli2/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/chime-2018-05-01/UpdatePhoneNumber) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/chime-2018-05-01/UpdatePhoneNumber)