Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Deletes an existing opt-out list. All opted out phone numbers in the opt-out list are deleted.

If the specified opt-out list name doesn't exist or is in-use by an origination phone number or pool, an error is returned.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.DeleteOptOutList' required

Request body

OptOutListNamestring required
<p>The OptOutListName or OptOutListArn of the OptOutList to delete. You can use <a>DescribeOptOutLists</a> to find the values for OptOutListName and OptOutListArn.</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>

Response

Success

OptOutListArnstring

The Amazon Resource Name (ARN) of the OptOutList that was removed.

OptOutListNamestring

The name of the OptOutList that was removed.

CreatedTimestampstring date-time

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