---
title: "POST /phone-numbers/{phoneNumberId}"
method: POST
path: "/phone-numbers/{phoneNumberId}"
---

# POST /phone-numbers/{phoneNumberId}

`POST /phone-numbers/{phoneNumberId}`

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.

## Path parameters

- `phoneNumberId` string, required

## Request body

- object
  - `ProductType` 'BusinessCalling' | 'VoiceConnector' | 'SipMediaApplicationDialIn' — The product type.
  - `CallingName` string, password — The outbound calling name associated with the phone number.

## Response `200`

Success

- UpdatePhoneNumberResponse
  - `PhoneNumber` object — The updated phone number details.
    - `PhoneNumberId` string — The phone number ID.
    - `E164PhoneNumber` string, password — The phone number, in E.164 format.
    - `Country` string — The phone number country. Format: ISO 3166-1 alpha-2.
    - `Type` 'Local' | 'TollFree' — The phone number type.
    - `ProductType` 'BusinessCalling' | 'VoiceConnector' | 'SipMediaApplicationDialIn' — The phone number product type.
    - `Status` 'AcquireInProgress' | 'AcquireFailed' | 'Unassigned' | 'Assigned' | 'ReleaseInProgress' | 'DeleteInProgress' | 'ReleaseFailed' | 'DeleteFailed' — The phone number status.
    - `Capabilities` object — The phone number capabilities.
      - `InboundCall` boolean — Allows or denies inbound calling for the specified phone number.
      - `OutboundCall` boolean — Allows or denies outbound calling for the specified phone number.
      - `InboundSMS` boolean — Allows or denies inbound SMS messaging for the specified phone number.
      - `OutboundSMS` boolean — Allows or denies outbound SMS messaging for the specified phone number.
      - `InboundMMS` boolean — Allows or denies inbound MMS messaging for the specified phone number.
      - `OutboundMMS` boolean — Allows or denies outbound MMS messaging for the specified phone number.
    - `Associations` PhoneNumberAssociation[] — The phone number associations.
      - `Value` string — Contains the ID for the entity specified in Name.
      - `Name` 'AccountId' | 'UserId' | 'VoiceConnectorId' | 'VoiceConnectorGroupId' | 'SipRuleId' — Defines the association with an Amazon Chime account ID, user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group ID.
      - `AssociatedTimestamp` string, date-time — The timestamp of the phone number association, in ISO 8601 format.
    - `CallingName` string, password — The outbound calling name associated with the phone number.
    - `CallingNameStatus` 'Unassigned' | 'UpdateInProgress' | 'UpdateSucceeded' | 'UpdateFailed' — The outbound calling name status.
    - `CreatedTimestamp` string, date-time — The phone number creation timestamp, in ISO 8601 format.
    - `UpdatedTimestamp` string, date-time — The updated phone number timestamp, in ISO 8601 format.
    - `DeletionTimestamp` string, date-time — The deleted phone number timestamp, in ISO 8601 format.

## Other responses

- `480` — UnauthorizedClientException
- `481` — NotFoundException
- `482` — ForbiddenException
- `483` — BadRequestException
- `484` — ThrottledClientException
- `485` — ConflictException
- `486` — ServiceUnavailableException
- `487` — ServiceFailureException

---

[API](https://skmtc.net/aws/apis/chime.md) · [All operations](https://skmtc.net/aws/apis/chime/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/chime/versions/40da18840201/schema)