Add suppressions in bulk
POST/v1/suppressions/batch
Adds up to 1,000 addresses at once. Duplicates are ignored.
Required scope: suppressions:manage
Request body
| Field | Type |
|---|---|
addressesrequired | string[] |
reasonoptional | string |
Unknown fields are rejected, so a typo never silently does nothing.
Example
curl -X POST 'https://api.sendsend.email/v1/suppressions/batch' \
-H "Authorization: Bearer $SENDSEND_API_KEY" \
-H 'Content-Type: application/json' \
-d '{
"addresses": [
"a@example.com",
"b@example.com"
]
}'Response 201
{
"object": "suppression_batch",
"added": 2
}Errors
| Status | Code | When |
|---|---|---|
| 400 | validation_error | The request body or parameters are invalid. The message says which field. |
| 401 | unauthorized | The API key is missing, invalid or revoked. |
| 403 | forbidden | The key does not have the scope this endpoint needs. |
Every error has the same shape. See Errors.