PUT

/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}

http://email.{region}.amazonaws.com/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}

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.

Access Token Required: API Key

Path Parameters

ContactListNamestringrequired

The name of the contact list.

EmailAddressstringrequired

The contact's email addres.

Body Params

AttributesDatastring

The attribute data attached to a contact.

UnsubscribeAllboolean

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

TopicPreferencesarray

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

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://email.{region}.amazonaws.com/v2/email/contact-lists/{ContactListName}/contacts/{EmailAddress}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}