v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Request a new sender ID that doesn't require registration.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.RequestSenderId' required

Request body

SenderIdstring required

The sender ID string to request. The sender ID can be 1-11 alphanumeric characters including letters (A-Z, a-z), numbers (0-9), or hyphens (-). The sender ID must contain at least one letter and cannot start or end with a hyphen.

IsoCountryCodestring required

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

MessageTypesMessageType[]

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.

DeletionProtectionEnabledboolean

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

ClientTokenstring

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don't specify a client token, a randomly generated token is used for the request to ensure idempotency.

Response

Success

SenderIdArnstring required

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

SenderIdstring required

The sender ID that was requested.

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.