Skip to main content
POST
/
suppression-list
Create Suppression Entries
curl --request POST \
  --url https://api.mailchannels.net/tx/v1/suppression-list \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '
{
  "suppression_entries": [
    {
      "recipient": "<string>",
      "notes": "<string>",
      "suppression_types": []
    }
  ],
  "add_to_sub_accounts": false
}
'
{
  "errors": [
    "<string>"
  ]
}

Headers

​
X-Api-Key
string
required

Body

application/json

The details of the suppression entries to create.

​
suppression_entries
object[]
required

The total number of suppression entries to create, for the parent and/or its sub-accounts, must not exceed 1000.

​
add_to_sub_accounts
boolean
default:false

If true, the parent account creates suppression entries for all associated sub-accounts. This field is only applicable to parent accounts. Sub-accounts cannot create entries for other sub-accounts.

Response

All suppression entries were successfully created.