Page tree

Description

Adds single or multiple email addresses to a suppression list.

Request URL

Method: POST

https://example.com/api/v1.1/suppresses/emails_add

Request parameters

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
emailsJSON array["john@example.com"]YesEmail addresses list
formatstring"json"NoResponse data format.
By default –json
idint1YesSuppression list ID

Request example

{
    "emails": [
        "john@example.com"
    ],
    "id": 1,
    "token": "abcdefghijklmnqrstuvwxyz"
}

Response example

{
    "error": 0,
    "error_text": "Successful operation",
    "total_count": 1,
    "total_duplicated": 0,
    "total_imported": 1,
    "total_updated": 0
}

Response parameters

ParameterTypeDescription
errorintError code
error_textstringError text
total_countintTotal number of emails
total_duplicatedintEmails previously added to the stop list
total_importedintEmails added
total_updatedintEmails updated (if matched)
  • No labels