Mail API reference

Mail API · Suppression

post/v1/workspaces/{workspace_id}/suppressionAuth

Add an email to the workspace suppression list

Path parameters

workspace_id*string · uuid

Id of the workspace.

Headers

Idempotency-Keystring

Opaque client-generated string (1–256 chars, `[A-Za-z0-9._:-]`) used to deduplicate retries within a 24h window. A retry with the same key and body returns the original response with `Idempotent-Replay: true`.

Request body

email*string · email

Address to suppress. Once listed, sends to it are dropped before delivery.

Example: "bounced@example.com"

reasonstring

Why it was suppressed. Free text, for the operator reading the list later.

Example: "hard bounce"

Response · 201

id*string · uuid

Suppression row id.

workspace_id*string · uuid

Workspace this suppression belongs to.

email*string · email

Suppressed recipient (lowercased on insert).

Example: "user@example.com"

reason*string

Free-text reason; null when unspecified.

source*object

Where the row originated.

added_at*string · date-time

Insertion (or last-touch) timestamp.

Example

Request

POST https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/suppression
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "email": "bounced@example.com",
  "reason": "hard bounce"
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "workspace_id": "00000000-0000-0000-0000-000000000000",
  "email": "user@example.com",
  "reason": "string",
  "source": {},
  "added_at": "2026-01-01T00:00:00.000Z"
}