Skip to content

Get Contact

sesv2_get_contact R Documentation

Returns a contact from a contact list

Description

Returns a contact from a contact list.

Usage

sesv2_get_contact(ContactListName, EmailAddress)

Arguments

ContactListName

[required] The name of the contact list to which the contact belongs.

EmailAddress

[required] The contact's email address.

Value

A list with the following syntax: 

list(
  ContactListName = "string",
  EmailAddress = "string",
  TopicPreferences = list(
    list(
      TopicName = "string",
      SubscriptionStatus = "OPT_IN"|"OPT_OUT"
    )
  ),
  TopicDefaultPreferences = list(
    list(
      TopicName = "string",
      SubscriptionStatus = "OPT_IN"|"OPT_OUT"
    )
  ),
  UnsubscribeAll = TRUE|FALSE,
  AttributesData = "string",
  CreatedTimestamp = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedTimestamp = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

svc$get_contact(
  ContactListName = "string",
  EmailAddress = "string"
)