Suppressions

Suppression list operations.

GET /suppressions

List suppressions

Returns the suppression entries across the authenticated user's sending domains, newest first. Each entry records the suppressed address, the reason (unsubscribe, hard_bounce, complaint, manual, list_import, or soft_bounce), its source, its scope, and an optional expires_at (null means permanent). The scope states what the entry blocks: marketing entries (unsubscribes) block campaign sends only, while all entries (bounces, complaints, manual additions) block transactional sends too. Supports the JSON:API filter (including filter[scope]), sort, include, and sparse fields parameters. Requires the suppressions:read scope.

Parameters

Name	In	Description
`filter`	query	Exact-match filters, e.g. filter[status]=delivered. Only the fields this endpoint allow-lists are accepted; an unsupported filter returns 400.
`sort`	query	Comma-separated sort fields; prefix a field with - for descending, e.g. sort=-created_at,name. Defaults to newest-first. Only allow-listed fields are accepted; an unsupported sort returns 400.
`include`	query	Comma-separated related resources to embed in the response included member (JSON:API compound documents). Example: include=records,webhooks. Nested paths use dot notation, max depth 2. Relationships not declared by the resource, or over-deep paths, return 400.
`fields`	query	Per-type sparse fieldsets. Example: fields[domains]=name,status restricts the returned attributes for that type. The type must be present in the document and each field must be a known attribute, otherwise 400 is returned.
`page`	query	Cursor-based pagination, e.g. page[cursor]=eyJpZCI6...&page[size]=50. The cursor is an opaque token issued by the API — take it from the response's links.next / links.prev URLs or meta.next_cursor / meta.prev_cursor; never construct one. size defaults to 25 and is silently capped at 100 (out-of-range or non-numeric values fall back to the default). An invalid or expired cursor falls back to the first page; a cursor replayed with a different sort than it was issued under returns 400; unknown page members such as page[number] return 400. Follow links.next until it is null (or meta.has_more is false) to traverse a collection; links.first restarts traversal. Link URLs carry these parameters URL-encoded (page%5Bcursor%5D=...).

GET /suppressions

curl -X GET https://api.minimailer.app/suppressions \
  -H "Authorization: Bearer $MINIMAILER_API_TOKEN" \
  -H "Accept: application/vnd.api+json"

Responses

Status	Description
400	The include or fields query parameter is not supported (unknown relationship, over-deep include, or unknown sparse-fieldset type or field). `ErrorDocument`
200	Suppressions retrieved. `SuppressionCollectionDocument`
401	Authentication is required. `ErrorDocument`
403	The authenticated token does not have permission to perform this action. `ErrorDocument`
406	The Accept header mentions the JSON:API media type only in instances modified by disallowed media type parameters (or only with unsupported ext extensions), so no acceptable representation remains. `ErrorDocument`
429	The caller exceeded the API rate limit. `ErrorDocument`

DELETE /suppressions/{suppression}

Delete a suppression

Removes a suppression entry, re-enabling sending to that address on the domain. Removal is only permitted for reversible reasons; hard_bounce and complaint suppressions are permanent (CAN-SPAM and sender-reputation protection) and cannot be deleted — attempting to do so returns 422. Requires the suppressions:write scope.

Parameters

Name	In	Description
`suppression` required	path	The suppression identifier.

DELETE /suppressions/{suppression}

curl -X DELETE https://api.minimailer.app/suppressions/{suppression} \
  -H "Authorization: Bearer $MINIMAILER_API_TOKEN" \
  -H "Accept: application/vnd.api+json"

Responses

Status	Description
204	Suppression deleted.
401	Authentication is required. `ErrorDocument`
403	The authenticated token does not have permission to perform this action. `ErrorDocument`
404	The requested resource could not be found. `ErrorDocument`
422	The request document failed validation, including when the suppression reason is permanent and cannot be removed. `ValidationErrorDocument`
406	The Accept header mentions the JSON:API media type only in instances modified by disallowed media type parameters (or only with unsupported ext extensions), so no acceptable representation remains. `ErrorDocument`
429	The caller exceeded the API rate limit. `ErrorDocument`