Suppress & unsuppress contacts

If you have questions regarding this API, please visit our API FAQ page.

Suppression is per-account and not tied to any contacts list: suppressed addresses are excluded from all sends. These endpoints operate on email addresses (not contact ids), so an address does not need to exist as a contact to be suppressed.

Note

Addresses suppressed through this endpoint are recorded with the source Web API, so you can tell them apart from suppressions added manually, via CSV import, or by the system.

Suppressing addresses

Make a POST request to https://webapi.inboxroad.com/api/v2/contacts/suppress/ with a valid X-API-Key. Pass one or more email addresses in the body.

curl -X POST 'https://webapi.inboxroad.com/api/v2/contacts/suppress/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "emails": ["john.doe@example.com", "jane.roe@example.com"]
  }'

Response

Returns 200. Addresses that were already suppressed are reported separately under already_blocked and left unchanged.

{
  "blocked": [
    { "id": 91, "email": "john.doe@example.com" }
  ],
  "already_blocked": [
    { "id": 42, "email": "jane.roe@example.com" }
  ]
}

Unsuppressing addresses

Make a POST request to https://webapi.inboxroad.com/api/v2/contacts/unsuppress/ with the same body shape.

curl -X POST 'https://webapi.inboxroad.com/api/v2/contacts/unsuppress/' \
  -H 'X-API-Key: <your_token>' \
  -H 'Content-Type: application/json' \
  -d '{
    "emails": ["john.doe@example.com"]
  }'

Response

Returns 200. Addresses that were not on the suppression list are reported under not_found.

{
  "unblocked": ["john.doe@example.com"],
  "not_found": []
}

Request fields

Field name	Required	Description
emails	Yes	Array of email addresses to add to / remove from the suppression list.

Possible response codes

Status code	Description
200	Suppression list updated successfully.
401	Unauthorized.
403	Action not available for your account. Body: { "errors": [ ... ] }.