UpdateContact - Amazon Simple Email Service

UpdateContact

Updates a contact's preferences for a list.

Note

You must specify all existing topic preferences in the TopicPreferences object, not just the ones that need updating; otherwise, all your existing preferences will be removed.

Request Syntax

PUT /v2/email/contact-lists/ContactListName/contacts/EmailAddress HTTP/1.1 Content-type: application/json { "AttributesData": "string", "TopicPreferences": [ { "SubscriptionStatus": "string", "TopicName": "string" } ], "UnsubscribeAll": boolean }

URI Request Parameters

The request uses the following URI parameters.

ContactListName

The name of the contact list.

Required: Yes

EmailAddress

The contact's email address.

Required: Yes

Request Body

The request accepts the following data in JSON format.

AttributesData

The attribute data attached to a contact.

Type: String

Required: No

TopicPreferences

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

Type: Array of TopicPreference objects

Required: No

UnsubscribeAll

A boolean value status noting if the contact is unsubscribed from all contact list topics.

Type: Boolean

Required: No

Response Syntax

HTTP/1.1 200

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input you provided is invalid.

HTTP Status Code: 400

ConcurrentModificationException

The resource is being modified by another operation or thread.

HTTP Status Code: 409

NotFoundException

The resource you attempted to access doesn't exist.

HTTP Status Code: 404

TooManyRequestsException

Too many requests have been made to the operation.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: