Skip to content

Delete Opt Out List

pinpointsmsvoicev2_delete_opt_out_list R Documentation

Deletes an existing opt-out list

Description

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.

Usage

pinpointsmsvoicev2_delete_opt_out_list(OptOutListName)

Arguments

OptOutListName

[required] The OptOutListName or OptOutListArn of the OptOutList to delete. You can use describe_opt_out_lists to find the values for OptOutListName and OptOutListArn.

Value

A list with the following syntax:

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

Request syntax

svc$delete_opt_out_list(
  OptOutListName = "string"
)