Suppressions

Create or import suppressions

POST/v1/suppressionsrequires suppression:write

One address, or data with up to 1,000. Use this to import Mailgun bounce, complaint, and unsubscribe lists. bounce and unsubscribe are accepted as type aliases. An existing stronger type (complaint, unsubscribe) is not downgraded by a bounce import.

Requestcurl -X POST https://api.transmit.dev/v1/suppressions \
  -H "Authorization: Bearer tr_v2_…" \
  -H "Content-Type: application/json" \
  -d '{
       "email": "former@example.com",
       "type": "hard_bounce",
       "reason": "Imported from Mailgun"
     }'

Body

Field	Type	Notes
`email` required	`string`	email
`type`	`"hard_bounce" \| "bounce" \| "complaint" \| "unsubscribed" \| "unsubscribe" \| "manual" \| "invalid"`
`reason`	`string`	at most 500 characters

Responses

Status	Meaning
`201`	The stored suppression, or `{ data, created }` for a bulk import
`401`	The API key is missing, malformed, expired or revoked
`403`	The API key lacks the `suppression:write` scope
`422`	The request failed validation

Every response body is described in the OpenAPI spec, which this page is generated from.