Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14109583546.7 KB

Creates an opted out destination phone number in the opt-out list.

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

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

Headers

X-Amz-Target'PinpointSMSVoiceV2.PutOptedOutNumber' required

Request body

OptOutListNamestring required
<p>The OptOutListName or OptOutListArn to add the phone number to.</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 to add to the OptOutList in E.164 format.

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 added to the OptOutList.

OptedOutTimestampstring date-time

The time that the phone number was added to the OptOutList, 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.