Reference

Check suppression

POST /v1/suppressions/check. Suppression status per record id, as of now.

Generated from the contractsView as Markdown

POST /v1/suppressions/check

Suppression status per record id, as of now. Run it before any send.

Property	Value
Endpoint	`POST https://mydatahub.emailmovers.com/v1/suppressions/check`
Operation id	`checkSuppression`
Cost	Free (0 credits)
Access	An API key or an OAuth 2.1 token with the scope `suppressions:read`.
MCP tool	`check_suppression`
Tag	Suppressions

Request

Parameters

Name	In	Type	Required	Description
`MyDataHub-Version`	header	string	no	The dated API version, pinned per key when left out. Non-breaking changes ship as new dates; the path major changes only for breaking changes, with a 12 month deprecation window.

Body

Member	Type	Required	Description
`record_ids`	array of string	yes

Example request

curl -X POST "https://mydatahub.emailmovers.com/v1/suppressions/check" \
  -H "Authorization: Bearer $MYDATAHUB_API_KEY" \
  -H "Content-Type: application/json" \
  --data '{
  "record_ids": ["contact_01JA9X2V7XN3M9R6T1Y5W8ZAK8"]
}'

Responses

200: Status per record.

Headers: RateLimit, RateLimit-Policy.

Member	Type	Always present	Description
`checked_at`	string (date-time)	yes
`results`	array of object	yes
`results[].record_id`	string	yes	Format: a contact id: contact_ followed by a 26 character ULID in upper case Crockford base32, such as contact_01JA9X2V7XN3M9R6T1Y5W8ZAK8.
`results[].suppressed`	boolean	yes
`results[].suppression_status`	enum: `none`, `objected_to_emailmovers`, `objected_to_licensee`, `deceased`, `left_company`	yes
`results[].list_ids`	array of string	yes

Example response

{
  "checked_at": "2026-10-01T09:00:00Z",
  "results": [
    {
      "record_id": "contact_01JA9X2V7XN3M9R6T1Y5W8ZAK8",
      "suppressed": false,
      "suppression_status": "none",
      "list_ids": []
    }
  ]
}

Errors

Every error is a problem object with a code and a next_step. Every response carries the RateLimit and RateLimit-Policy headers; see Rate limits.

Status	Problem codes	When
400	`invalid-request`, `idempotency-key-required`, `unsupported-version`	The request could not be read, or an Idempotency-Key is missing.
401	`authentication-required`, `account-required`	Sign in (OAuth) or send an API key (authentication-required), or create a free account for what the anonymous tier does not cover (account-required).
403	`insufficient-scope`, `confirmation-required`, `business-details-required`, `licence-acceptance-required`, `dpa-acceptance-required`, `agent-budget-exceeded`	The token lacks a scope (insufficient-scope, with required_scope and a WWW-Authenticate step-up challenge); no person confirmed the spend and no agent key covers it (confirmation-required, with an approval_url); an agent key's per-order cap or monthly budget does not cover it (agent-budget-exceeded); an account made by self-serve sign-up has not yet confirmed its business name and that it is a UK business, which its first order needs (business-details-required); the order needs the Data Licence and Sharing Agreement accepted at the version in force (licence-acceptance-required); or a suppression upload comes before the organisation has accepted the Article 28 data processing agreement in force (dpa-acceptance-required). Nothing is charged.
422	`validation-failed`, `quote-required`, `dataset-unavailable`	The request is not valid. errors lists every problem with a JSON pointer and did_you_mean.
429	`rate-limited`	Too many requests. Wait for Retry-After.
Any other failure	`internal-error`, `service-unavailable`, `tps-screen-expired`	Something failed on our side (500 internal-error) or the service is briefly unavailable (503 service-unavailable, with Retry-After). Nothing was charged; retry with the same Idempotency-Key. A count, sample, quote or order with telephone in play is also refused with 503 tps-screen-expired, with no Retry-After, while the dataset version's TPS and CTPS screen is more than 28 days old.