ISESV2UpdateContactRequest
Interface in AWS.SESV2
Interface of UpdateContact requests.
Ancestors
Properties
ContactListName
property ContactListName: string
The name of the contact list containing the contact to update.
This identifies the specific contact list where the contact's subscription preferences and attributes will be updated. The contact list must exist in your Amazon SES account. This field is required and must reference an existing contact list that contains the specified email address contact.
EmailAddress
property EmailAddress: string
The email address of the contact to update.
This identifies the specific contact within the contact list whose preferences and attributes will be modified. The contact must already exist within the specified contact list. This field is required and must be a properly formatted email address that is currently registered as a contact in the specified contact list.
AttributesData
property AttributesData: string
The attribute data attached to the contact.
This contains custom data associated with the contact, typically stored as a JSON string with key-value pairs representing contact properties such as name, preferences, demographic information, or other relevant metadata. This field is optional. When not specified, the existing attribute data for the contact remains unchanged. When specified, it replaces all existing attribute data for the contact. Attribute data enables personalization of email campaigns and segmentation of contact lists based on subscriber characteristics and preferences.
TopicPreferences
property TopicPreferences: ISESV2TopicPreference
Type: ISESV2TopicPreference
The contact's preferences for being opted-in to or opted-out of specific topics.
This array contains the subscription status for each topic defined in the contact list. Each topic preference specifies whether the contact is subscribed or unsubscribed from that particular email topic or category. This field is optional, but when specified, you must include all existing topic preferences that you want to preserve. Any topic preferences not included in this array will be removed from the contact's preferences. Topic preferences enable granular subscription management, allowing contacts to subscribe to specific types of content while unsubscribing from others, improving engagement and compliance with email marketing regulations.
UnsubscribeAll
property UnsubscribeAll: TOptional<Boolean>
Indicates whether the contact is unsubscribed from all topics in the contact list.
When set to True, the contact is unsubscribed from all email topics in the contact list and will not receive any emails. When set to False, the contact's individual topic preferences determine their subscription status. This field is optional and provides a master unsubscribe control that overrides individual topic preferences. This is useful for implementing global unsubscribe functionality that complies with email marketing regulations. Setting this to true effectively suppresses all email delivery to the contact regardless of their individual topic subscription preferences.