GET/suppressions/check

GET /suppressions/check

Ask whether we would send to an address, and if not, why.

View as Markdown

Request

curl -X GET 'https://api.sendheron.com/api/v1/suppressions/check' \
  -H 'Authorization: Bearer <YOUR_API_KEY>' \
  -H 'Content-Type: application/json'

Required scopes

The key must carry these:

  • suppressions:read

Query parameters

NameTypeRequiredDescription
emailstringYesThe address to check.

Responses

Returns 200 on success.

400
The payload failed validation, or the request is not valid for the current state.
401
Missing or invalid API key.
403
Valid key, but it does not carry the required scope.
404
No such record in this workspace.
409
A duplicate, or an idempotency key reused with a different payload.
429
Either rate-limit ceiling was exceeded.

Rate limits

100/min per key, counted against the organization's READ ceiling (1200/min). Both windows are one minute. There is no hourly or daily quota.