Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Updates the configuration of an existing sender ID.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.UpdateSenderId' required

Request body

SenderIdstring required

The sender ID to update.

IsoCountryCodestring required

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

DeletionProtectionEnabledboolean

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

Response

Success

SenderIdArnstring required

The Amazon Resource Name (ARN) associated with the SenderId.

SenderIdstring required

The sender ID that was updated.

IsoCountryCodestring required

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

MessageTypesMessageType[] required

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.

MonthlyLeasingPricestring required

The monthly price, in US dollars, to lease the sender ID.

DeletionProtectionEnabledboolean required

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

Registeredboolean required

True if the sender ID is registered..

RegistrationIdstring

The unique identifier for the registration.