PushizoDocs
API reference

Suppression list

Suppression list — 3 operations (GET /v1/apps/{appId}/suppressions, POST /v1/apps/{appId}/suppressions, DELETE /v1/apps/{appId}/suppressions/{suppressionId}). Generated from the OpenAPI 3.1.0 contract.

Email/SMS send block list (bounce, complaint, STOP, manual): add, list and remove.

Base URL: https://api.pushizo.com · Tag: suppressions · Interactive docs (Scalar)

Operations

Details

Suppression list (email/SMS addresses that will not be sent to; channel/reason/value filter)

GET/v1/apps/{appId}/suppressionsTry it (interactive API docs, new tab)

Authentication: API key — scope users:read (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
channelqueryenumNoValues: "email", "sms", "whatsapp", "rcs", "telegram", "viber""email"
reasonqueryenumNoValues: "bounce", "complaint", "manual", "unsubscribe_link", "stop""bounce"
valuequerystringNoLength: 3–320"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SuppressionPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].channelenumYesValues: "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].value_maskedstringYes
data[].reasonenumYesValues: "bounce", "complaint", "manual", "unsubscribe_link", "stop"
data[].sourcestringYes
data[].detailmap<string, any>Yes
data[].expires_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "channel": "email",
      "id": "sup_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "value_masked": "örnek",
      "reason": "bounce",
      "source": "örnek",
      "detail": {
        "key": "örnek"
      },
      "expires_at": "örnek",
      "created_at": "örnek",
      "updated_at": "örnek"
    }
  ],
  "next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
  "has_more": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/suppressions?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Add an address (manual block; the value is not stored, only a digest and masked display)

POST/v1/apps/{appId}/suppressionsTry it (interactive API docs, new tab)

Authentication: API key — scope users:write (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateSuppressionDto

FieldTypeRequiredDescription
channelenumYesValues: "email", "sms", "whatsapp", "rcs", "telegram", "viber"
valuestringYesLength: 3–320
reasonenumNoValues: "manual", "bounce", "complaint", "unsubscribe_link", "stop"
expires_atstring (date-time)No
notestringNoLength: 0–500

Example:

{
  "channel": "email",
  "value": "user_42",
  "reason": "manual",
  "expires_at": "2026-10-17T09:00:00Z",
  "note": "örnek"
}

Responses

201 — Success.

Schema: Suppression

FieldTypeRequiredDescription
idstringYes
app_idstringYes
channelenumYesValues: "email", "sms", "whatsapp", "rcs", "telegram", "viber"
value_maskedstringYes
reasonenumYesValues: "bounce", "complaint", "manual", "unsubscribe_link", "stop"
sourcestringYes
detailmap<string, any>Yes
expires_atstring | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "channel": "email",
  "id": "sup_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "value_masked": "örnek",
  "reason": "bounce",
  "source": "örnek",
  "detail": {
    "key": "örnek"
  },
  "expires_at": "örnek",
  "created_at": "örnek",
  "updated_at": "örnek"
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/suppressions" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "channel": "email",
  "value": "user_42",
  "reason": "manual",
  "expires_at": "2026-10-17T09:00:00Z",
  "note": "örnek"
}'

Remove an entry (the address can receive sends again)

DELETE/v1/apps/{appId}/suppressions/{suppressionId}Try it (interactive API docs, new tab)

Authentication: API key — scope users:write (admin includes every scope).

Parameters

NameInTypeRequiredDescriptionExample
suppressionIdpathstringYes"sup_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/suppressions/sup_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

On this page