v1 · API reference

Suppressions

Address-level send blocks — the hard "never email this address" list. Combines engine-written bounce/complaint entries, your own additions, and read-only Unitpost-wide blocks.

Base URL: https://www.unitpost.com/api/v1/api/v1

Suppressions

List suppressed addresses

GET/api/v1/api/v1/suppressions

GET /suppressions

curl -X GET 'https://www.unitpost.com/api/v1/api/v1/suppressions' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "object": "suppression",
      "id": "id_123",
      "email": "customer@example.com",
      "scope": "workspace",
      "reason": "bounce",
      "detail": "string",
      "note": "string",
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ]
}

Retrieve a list of email addresses that are blocked from receiving your mail, newest-first and cursor-paginated. The list includes your workspace's own suppressions AND the read-only Unitpost-wide (platform) entries that would block a send — so it's the complete answer to "why isn't this address getting mail?". Pass ?scope=workspace to hide platform rows. Add an address with Suppress an address or lift a block with Un-suppress an address. Requires the suppressions:read capability.

Parameters4 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).
`scope`	string · query	Filter by scope. `workspace` returns only your own suppressions; omit (or any other value) to also include read-only `platform` rows.

Response · 200 fields9 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`email`required	string	—
`scope`required	enumworkspace \| platform	—
`reason`required	enumbounce \| complaint \| unsubscribe \| manual \| import \| api	—
`detail`required	object	—
`note`required	object	—
`created_at`required	string	—
`updated_at`required	string	—

200401403422

Suppress an address

POST/api/v1/api/v1/suppressions

POST /suppressions

curl -X POST 'https://www.unitpost.com/api/v1/api/v1/suppressions' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{ }'

Response · 200

{
  "object": "suppression",
  "id": "id_123",
  "email": "customer@example.com",
  "scope": "workspace",
  "reason": "bounce",
  "detail": "string",
  "note": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Block one address ({ email }) or up to 1,000 at once ({ emails: [...] }) from receiving any future sends from your workspace. The operation is idempotent — re-suppressing an existing address returns 200 rather than a conflict. The bulk form returns an { object: "list", added, skipped, total } summary. Suppression is the hard stop; to let recipients opt out of just one kind of email, use topics (see Create a topic). Undo with Un-suppress an address. Requires the suppressions:write capability.

Request body4 fields

Field	Type	Description
`email`	string	—
`emails`	string[]	—
`reason`	enummanual \| import \| api	—
`note`	string	—

200201401403422

Retrieve a suppressed address

GET/api/v1/api/v1/suppressions/{id}

GET /suppressions/{id}

curl -X GET 'https://www.unitpost.com/api/v1/api/v1/suppressions/123' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Response · 200

{
  "object": "suppression",
  "id": "id_123",
  "email": "customer@example.com",
  "scope": "workspace",
  "reason": "bounce",
  "detail": "string",
  "note": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}

Retrieve one suppression by id (supp_…) or by the email address itself. Returns your own workspace row, or a read-only platform row when the address is blocked Unitpost-wide. Lift a workspace block with Un-suppress an address. Requires the suppressions:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	A suppression id (`supp_…`) or the email address.

Response · 200 fields9 fields

Field	Type	Description
`object`required	string	—
`id`required	string	—
`email`required	string	—
`scope`required	enumworkspace \| platform	—
`reason`required	enumbounce \| complaint \| unsubscribe \| manual \| import \| api	—
`detail`required	object	—
`note`required	object	—
`created_at`required	string	—
`updated_at`required	string	—

200401403404

Un-suppress an address

DELETE/api/v1/api/v1/suppressions/{id}

DELETE /suppressions/{id}

curl -X DELETE 'https://www.unitpost.com/api/v1/api/v1/suppressions/123' \
  -H 'Authorization: Bearer YOUR_API_KEY'

Remove a workspace suppression by id or email so the address can receive your mail again. The email form is idempotent — removing an address that isn't suppressed still returns 204. Unitpost-wide (platform) entries can't be removed here (403) — contact support. Check what's blocking an address first with Retrieve a suppressed address. Requires the suppressions:write capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	A suppression id (`supp_…`) or the email address.

204401403404