UpdatePhoneNumberMetadata - Amazon Connect


Updates a phone number’s metadata.


To verify the status of a previous UpdatePhoneNumberMetadata operation, call the DescribePhoneNumber API.

Request Syntax

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

URI Request Parameters

The request uses the following URI parameters.


The Amazon Resource Name (ARN) or resource ID of 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. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

Type: String

Length Constraints: Maximum length of 500.

Required: No


The description of the phone number.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 500.

Pattern: ^[\W\S_]*

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

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


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


The request is 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: