POST /v1/suppressions

Family: Suppressions · Operation ID: v1_add_suppressions

Access

Workspace API key: Authorization: Bearer <key>. The key is scoped to its workspace; the backend checks operation permissions and quota.

Open suppressions

Required scope: suppressions

Create a key in Developer settings. Set API_BASE_URL to the current app origin.

Request example

curl --fail-with-body -X POST "$API_BASE_URL/v1/suppressions" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

Request body · application/json

{
  "$ref": "#/components/schemas/AddSuppressionsRequest",
  "definition": {
    "properties": {
      "emails": {
        "items": {
          "type": "string"
        },
        "type": "array"
      },
      "expires_at": {
        "format": "date-time",
        "nullable": true,
        "type": "string"
      },
      "metadata": {
        "additionalProperties": true,
        "type": "object"
      },
      "notes": {
        "nullable": true,
        "type": "string"
      },
      "reason": {
        "$ref": "#/components/schemas/SuppressionReason"
      },
      "reason_detail": {
        "nullable": true,
        "type": "string"
      },
      "source": {
        "nullable": true,
        "type": "string"
      },
      "source_ref": {
        "nullable": true,
        "type": "string"
      },
      "source_type": {
        "nullable": true,
        "type": "string"
      }
    },
    "required": [
      "emails"
    ],
    "type": "object"
  }
}

Responses

200

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/AddSuppressionsResponse"
      }
    }
  },
  "description": "Suppression entries added"
}

default

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/ErrorEnvelope"
      }
    }
  },
  "description": "Request error"
}

Download the full OpenAPI contract