v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

Updates your claimed phone number from its current Amazon Connect instance or traffic distribution group to another Amazon Connect instance or traffic distribution group in the same Amazon Web Services Region.

You can call DescribePhoneNumber API to verify the status of a previous UpdatePhoneNumber operation.

put/phone-number/{PhoneNumberId}

Path parameters

PhoneNumberIdstring required

A unique identifier for the phone number.

Request body

TargetArnstring required

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

ClientTokenstring

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see <a href="https://aws.amazon.com/builders-library/making-retries-safe-with-idempotent-APIs/">Making retries safe with idempotent APIs</a>.

Response

Success

PhoneNumberIdstring

A unique identifier for the phone number.

PhoneNumberArnstring

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