UpdatePhoneNumber - Amazon Connect


Updates your claimed phone number from its current Amazon Connect instance to another Amazon Connect instance in the same Region.

Request Syntax

PUT /phone-number/PhoneNumberId HTTP/1.1 Content-type: application/json { "ClientToken": "string", "TargetArn": "string" }

URI Request Parameters

The request uses the following URI parameters.


A unique identifier for the phone number.

Required: Yes

Request Body

The request accepts the following data in JSON format.


A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Type: String

Length Constraints: Maximum length of 500.

Required: No


The Amazon Resource Name (ARN) for Amazon Connect instances that phone numbers are claimed to.

Type: String

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "PhoneNumberArn": "string", "PhoneNumberId": "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.


The Amazon Resource Name (ARN) of the phone number.

Type: String


A unique identifier for the phone number.

Type: String


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


You do not have sufficient permissions to perform this action.

HTTP Status Code: 403


An entity with the same name already exists.

HTTP Status Code: 409


Request processing failed because of an error or failure with the service.

HTTP Status Code: 500


One or more of the specified parameters are not valid.

HTTP Status Code: 400


That resource is already in use. Please try another.

HTTP Status Code: 409


The specified resource was not found.

HTTP Status Code: 404


The throttling limit has been exceeded.

HTTP Status Code: 429

See Also

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