v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Creates a new opt-out list.

If the opt-out list name already exists, an error is returned.

An opt-out list is a list of phone numbers that are opted out, meaning you can't send SMS or voice messages to them. If end user replies with the keyword "STOP," an entry for the phone number is added to the opt-out list. In addition to STOP, your recipients can use any supported opt-out keyword, such as CANCEL or OPTOUT. For a list of supported opt-out keywords, see SMS opt out in the End User Messaging SMS User Guide.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.CreateOptOutList' required

Request body

OptOutListNamestring required

The name of the new OptOutList.

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

OptOutListArnstring

The Amazon Resource Name (ARN) for the OptOutList.

OptOutListNamestring

The name of the new OptOutList.

CreatedTimestampstring date-time

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