Skip to main content
POST
/
suppression-groups
/
emails
/
suppress
curl --request POST \
  --url 'https://api.autosend.com/v1/suppression-groups/emails/suppress' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "emails": ["[email protected]", "[email protected]"],
    "groupId": "AB12C3",
    "reason": "unsubscribed",
    "isGlobal": false
  }'

{
  "success": true,
  "data": {
    "suppressed": 2
  }
}

curl --request POST \
  --url 'https://api.autosend.com/v1/suppression-groups/emails/suppress' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
    "emails": ["[email protected]", "[email protected]"],
    "groupId": "AB12C3",
    "reason": "unsubscribed",
    "isGlobal": false
  }'

{
  "success": true,
  "data": {
    "suppressed": 2
  }
}

​
Authorizations

​
Authorizations
string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Body

​
emails
string[]
required
An array of valid email addresses to suppress. Must contain at least one address.
​
groupId
string
The ID of the suppression group to add the addresses to. Omit to add to the default group.
​
reason
string
The reason for suppression (e.g. unsubscribed, bounced, spam_complaint). Stored on each entry for reporting.
​
isGlobal
boolean
When true, adds the entries to the global suppression list rather than a project-specific group.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
emails
string<email>[]
required
Minimum array length: 1
Example:
["[email protected]", "[email protected]"]
​
groupId
string
Example:

"AB12C3"

​
reason
string
Example:

"unsubscribed"

​
isGlobal
boolean
Example:

false

Response

200 - application/json

Emails suppressed successfully.

​
success
boolean
Example:

true

​
data
object