Delete Opted Out Number

pinpointsmsvoicev2_delete_opted_out_number

R Documentation

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

Description¶

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.

Usage¶

pinpointsmsvoicev2_delete_opted_out_number(OptOutListName,
  OptedOutNumber)

Arguments¶

OptOutListName

[required] The OptOutListName or OptOutListArn to remove the phone number from.

If you are using a shared AWS End User Messaging SMS and Voice resource then you must use the full Amazon Resource Name(ARN).

OptedOutNumber

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

Value¶

A list with the following syntax:

list(
  OptOutListArn = "string",
  OptOutListName = "string",
  OptedOutNumber = "string",
  OptedOutTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  EndUserOptedOut = TRUE|FALSE
)

Request syntax¶

svc$delete_opted_out_number(
  OptOutListName = "string",
  OptedOutNumber = "string"
)