Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Deletes an existing opted out destination phone number from the specified opt-out list.

Each destination phone number can only be deleted once every 30 days.

If the specified destination phone number doesn't exist or if the opt-out list doesn't exist, an error is returned.

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.DeleteOptedOutNumber' required

Request body

OptOutListNamestring required
<p>The OptOutListName or OptOutListArn to remove the phone number from.</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>
OptedOutNumberstring required

The phone number, in E.164 format, to remove from the OptOutList.

Response

Success

OptOutListArnstring

The OptOutListArn that the phone number was removed from.

OptOutListNamestring

The OptOutListName that the phone number was removed from.

OptedOutNumberstring

The phone number that was removed from the OptOutList.

OptedOutTimestampstring date-time

The time that the number was removed at, in <a href="https://www.epochconverter.com/">UNIX epoch time</a> format.

EndUserOptedOutboolean

This is true if it was the end user who requested their phone number be removed.