update_contact

SESV2.Client.update_contact(**kwargs)

Updates a contact's preferences for a list. It is not necessary to specify all existing topic preferences in the TopicPreferences object, just the ones that need updating.

See also: AWS API Documentation

Request Syntax

response = client.update_contact(
    ContactListName='string',
    EmailAddress='string',
    TopicPreferences=[
        {
            'TopicName': 'string',
            'SubscriptionStatus': 'OPT_IN'|'OPT_OUT'
        },
    ],
    UnsubscribeAll=True|False,
    AttributesData='string'
)
Parameters
  • ContactListName (string) --

    [REQUIRED]

    The name of the contact list.

  • EmailAddress (string) --

    [REQUIRED]

    The contact's email addres.

  • TopicPreferences (list) --

    The contact's preference for being opted-in to or opted-out of a topic.

    • (dict) --

      The contact's preference for being opted-in to or opted-out of a topic.

      • TopicName (string) -- [REQUIRED]

        The name of the topic.

      • SubscriptionStatus (string) -- [REQUIRED]

        The contact's subscription status to a topic which is either OPT_IN or OPT_OUT .

  • UnsubscribeAll (boolean) -- A boolean value status noting if the contact is unsubscribed from all contact list topics.
  • AttributesData (string) -- The attribute data attached to a contact.
Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • SESV2.Client.exceptions.BadRequestException
  • SESV2.Client.exceptions.TooManyRequestsException
  • SESV2.Client.exceptions.NotFoundException
  • SESV2.Client.exceptions.ConcurrentModificationException