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
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/suppressions | Suppression list (email/SMS addresses that will not be sent to; channel/reason/value filter) |
POST | /v1/apps/{appId}/suppressions | Add an address (manual block; the value is not stored, only a digest and masked display) |
DELETE | /v1/apps/{appId}/suppressions/{suppressionId} | Remove an entry (the address can receive sends again) |
Details
Suppression list (email/SMS addresses that will not be sent to; channel/reason/value filter)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
channel | query | enum | No | Values: "email", "sms", "whatsapp", "rcs", "telegram", "viber" | "email" |
reason | query | enum | No | Values: "bounce", "complaint", "manual", "unsubscribe_link", "stop" | "bounce" |
value | query | string | No | Length: 3–320 | "user_42" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SuppressionPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].channel | enum | Yes | Values: "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].value_masked | string | Yes | |
data[].reason | enum | Yes | Values: "bounce", "complaint", "manual", "unsubscribe_link", "stop" |
data[].source | string | Yes | |
data[].detail | map<string, any> | Yes | |
data[].expires_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
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)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateSuppressionDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
value | string | Yes | Length: 3–320 |
reason | enum | No | Values: "manual", "bounce", "complaint", "unsubscribe_link", "stop" |
expires_at | string (date-time) | No | |
note | string | No | Length: 0–500 |
Example:
{
"channel": "email",
"value": "user_42",
"reason": "manual",
"expires_at": "2026-10-17T09:00:00Z",
"note": "örnek"
}Responses
201 — Success.
Schema: Suppression
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
channel | enum | Yes | Values: "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
value_masked | string | Yes | |
reason | enum | Yes | Values: "bounce", "complaint", "manual", "unsubscribe_link", "stop" |
source | string | Yes | |
detail | map<string, any> | Yes | |
expires_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
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)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
suppressionId | path | string | Yes | "sup_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
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"Categories and preferences
Categories and preferences — 6 operations (GET /v1/apps/{appId}/categories, POST /v1/apps/{appId}/categories, PATCH /v1/apps/{appId}/categories/{categoryId}, …). Generated from the OpenAPI 3.1.0 contract.
iOS Live Activities
iOS Live Activities — 7 operations (GET /v1/apps/{appId}/live-activities/types, POST /v1/apps/{appId}/live-activities/types, PATCH /v1/apps/{appId}/live-activities/types/{activityType}, …). Generated from the OpenAPI 3.1.0 contract.