PutOptedOutNumber - Amazon Pinpoint SMS and Voice v2 API

PutOptedOutNumber

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.

Request Syntax

{ "OptedOutNumber": "string", "OptOutListName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

OptedOutNumber

The phone number to add to the OptOutList in E.164 format.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: \+?[1-9][0-9]{1,18}

Required: Yes

OptOutListName

The OptOutListName or OptOutListArn to add the phone number to.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [A-Za-z0-9_:/-]+

Required: Yes

Response Syntax

{ "EndUserOptedOut": boolean, "OptedOutNumber": "string", "OptedOutTimestamp": number, "OptOutListArn": "string", "OptOutListName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

EndUserOptedOut

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

Type: Boolean

OptedOutNumber

The phone number that was added to the OptOutList.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: \+?[1-9][0-9]{1,18}

OptedOutTimestamp

The time that the phone number was added to the OptOutList, in UNIX epoch time format.

Type: Timestamp

OptOutListArn

The OptOutListArn that the phone number was removed from.

Type: String

OptOutListName

The OptOutListName that the phone number was removed from.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_-]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ResourceNotFoundException

A requested resource couldn't be found.

HTTP Status Code: 400

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: