Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Updates the configuration of an existing origination phone number. You can update the opt-out list, enable or disable two-way messaging, change the TwoWayChannelArn, enable or disable self-managed opt-outs, and enable or disable deletion protection.

If the origination phone number is associated with a pool, an error is returned.

post/#X-Amz-Target=PinpointSMSVoiceV2.UpdatePhoneNumber

Headers

X-Amz-Target'PinpointSMSVoiceV2.UpdatePhoneNumber' required

Request body

PhoneNumberIdstring required
<p>The unique identifier of the phone number. Valid values for this field can be either the PhoneNumberId or PhoneNumberArn.</p> <important> <p>If you are using a shared End User Messaging SMS resource then you must use the full Amazon Resource Name(ARN).</p> </important>
TwoWayEnabledboolean

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

TwoWayChannelArnstring

The Amazon Resource Name (ARN) of the two way channel.

TwoWayChannelRolestring

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

SelfManagedOptOutsEnabledboolean

By default this is set to false. When set to false and an end recipient sends a message that begins with HELP or STOP to one of your dedicated numbers, End User Messaging SMS automatically replies with a customizable message and adds the end recipient to the OptOutList. When set to true you're responsible for responding to HELP and STOP requests. You're also responsible for tracking and honoring opt-out requests.

OptOutListNamestring

The OptOutList to add the phone number to. You can use either the opt out list name or the opt out list ARN.

InternationalSendingEnabledboolean

By default this is set to false. When set to true the international sending of phone number is Enabled.

DeletionProtectionEnabledboolean

By default this is set to false. When set to true the phone number can't be deleted.

Response

Success

PhoneNumberArnstring

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

PhoneNumberIdstring

The unique identifier of the phone number.

PhoneNumberstring

The phone number that was updated.

Status'PENDING' | 'ACTIVE' | 'ASSOCIATING' | 'DISASSOCIATING' | 'DELETED'

The current status of the request.

IsoCountryCodestring

The two-character code, in ISO 3166-1 alpha-2 format, for the country or region.

MessageType'TRANSACTIONAL' | 'PROMOTIONAL'

The type of message. Valid values are TRANSACTIONAL for messages that are critical or time-sensitive and PROMOTIONAL for messages that aren't critical or time-sensitive.

NumberCapabilitiesNumberCapability[]

Specifies if the number could be used for text messages, voice or both.

NumberType'SHORT_CODE' | 'LONG_CODE' | 'TOLL_FREE' | 'TEN_DLC' | 'SIMULATOR'

The type of number that was requested.

MonthlyLeasingPricestring

The monthly leasing price of the phone number, in US dollars.

TwoWayEnabledboolean

By default this is set to false. When set to true you can receive incoming text messages from your end recipients.

TwoWayChannelArnstring

The Amazon Resource Name (ARN) of the two way channel.

TwoWayChannelRolestring

An optional IAM Role Arn for a service to assume, to be able to post inbound SMS messages.

SelfManagedOptOutsEnabledboolean

This is true if self managed opt-out are enabled.

OptOutListNamestring

The name of the OptOutList associated with the phone number.

InternationalSendingEnabledboolean

When set to true the international sending of phone number is Enabled.

DeletionProtectionEnabledboolean

When set to true the phone number can't be deleted.

RegistrationIdstring

The unique identifier for the registration.

CreatedTimestampstring date-time

The time when the phone number was created, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.