POST

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

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

Creates a contact, which is an end-user who is receiving the email, and adds them to a contact list.

Access Token Required: API Key

Path Parameters

ContactListNamestringrequired

The name of the contact list to which the contact should be added.

Body Params

EmailAddressstringrequired

The contact's email address.

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 preferences for being opted-in to or opted-out of topics.

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 POST \
2     --url 'http://email.{region}.amazonaws.com/v2/email/contact-lists/{ContactListName}/contacts' \
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}