Skip to content

Get Contact List

sesv2_get_contact_list R Documentation

Returns contact list metadata

Description

Returns contact list metadata. It does not return any information about the contacts present in the list.

Usage

sesv2_get_contact_list(ContactListName)

Arguments

ContactListName

[required] The name of the contact list.

Value

A list with the following syntax:

list(
  ContactListName = "string",
  Topics = list(
    list(
      TopicName = "string",
      DisplayName = "string",
      Description = "string",
      DefaultSubscriptionStatus = "OPT_IN"|"OPT_OUT"
    )
  ),
  Description = "string",
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Request syntax

svc$get_contact_list(
  ContactListName = "string"
)