Create Opt Out List

pinpointsmsvoicev2_create_opt_out_list

R Documentation

Creates a new opt-out list¶

Description¶

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 AWS End User Messaging SMS User Guide.

Usage¶

pinpointsmsvoicev2_create_opt_out_list(OptOutListName, Tags,
  ClientToken)

Arguments¶

OptOutListName: [required] The name of the new OptOutList.
Tags: An array of tags (key and value pairs) to associate with the new OptOutList.
ClientToken: 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.

Value¶

A list with the following syntax:

list(
  OptOutListArn = "string",
  OptOutListName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax¶

svc$create_opt_out_list(
  OptOutListName = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  ),
  ClientToken = "string"
)