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.
Subscription categories and per-user channel/category preferences; the preference center is powered by these endpoints.
Base URL: https://api.pushizo.com · Tag: preferences · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/categories | Message categories |
POST | /v1/apps/{appId}/categories | Create a category |
PATCH | /v1/apps/{appId}/categories/{categoryId} | Update a category |
DELETE | /v1/apps/{appId}/categories/{categoryId} | Delete a category |
GET | /v1/apps/{appId}/users/by/{label}/{value}/preferences | User preferences (by alias) |
PUT | /v1/apps/{appId}/users/by/{label}/{value}/preferences | Write user preferences (by alias) |
Details
Message categories
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: MessageCategoryList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].key | string | Yes | |
data[].name | map<string, string> | Yes | |
data[].description | map<string, string> | Yes | |
data[].channels | array<string> | null | Yes | |
data[].default_opted_in | boolean | Yes | |
data[].position | integer | Yes | |
data[].opted_out_users | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": {
"key": "user_42"
},
"channels": [
"web_push"
],
"id": "cat_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"key": "key-2026-10",
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1,
"opted_out_users": 1,
"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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/categories" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create a category
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: CreateCategoryDto
| Field | Type | Required | Description |
|---|---|---|---|
key | string | Yes | Length: 1–64 |
name | map<string, string> | Yes | |
description | map<string, string> | No | |
channels | array<enum> | null | No | |
default_opted_in | boolean | No | |
position | integer | No | Range: 0–1000 |
Example:
{
"name": {
"key": "user_42"
},
"key": "key-2026-10",
"channels": [
"ios_push"
],
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1
}Responses
201 — Success.
Schema: MessageCategory
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
key | string | Yes | |
name | map<string, string> | Yes | |
description | map<string, string> | Yes | |
channels | array<string> | null | Yes | |
default_opted_in | boolean | Yes | |
position | integer | Yes | |
opted_out_users | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": {
"key": "user_42"
},
"channels": [
"web_push"
],
"id": "cat_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"key": "key-2026-10",
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1,
"opted_out_users": 1,
"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/categories" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": {
"key": "user_42"
},
"key": "key-2026-10",
"channels": [
"ios_push"
],
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1
}'Update a category
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
categoryId | path | string | Yes | "cat_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateCategoryDto
| Field | Type | Required | Description |
|---|---|---|---|
name | map<string, string> | No | |
description | map<string, string> | No | |
channels | array<enum> | null | No | |
default_opted_in | boolean | No | |
position | integer | No | Range: 0–1000 |
Example:
{
"name": {
"key": "user_42"
},
"channels": [
"ios_push"
],
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1
}Responses
200 — Success.
Schema: MessageCategory
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
key | string | Yes | |
name | map<string, string> | Yes | |
description | map<string, string> | Yes | |
channels | array<string> | null | Yes | |
default_opted_in | boolean | Yes | |
position | integer | Yes | |
opted_out_users | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": {
"key": "user_42"
},
"channels": [
"web_push"
],
"id": "cat_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"key": "key-2026-10",
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1,
"opted_out_users": 1,
"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 PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/categories/cat_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": {
"key": "user_42"
},
"channels": [
"ios_push"
],
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1
}'Delete a category
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
categoryId | path | string | Yes | "cat_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/categories/cat_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"User preferences (by alias)
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
label | path | string | Yes | "external_id" | |
value | path | string | Yes | "user_42" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UserPreferences
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
data | array<object> | Yes | |
data[].category | string | Yes | |
data[].channel | string | null | Yes | |
data[].opted_in | boolean | Yes | |
data[].explicit | boolean | Yes | |
data[].source | string | null | Yes | |
data[].updated_at | string | null | Yes | |
categories | array<object> | Yes | |
categories[].id | string | Yes | |
categories[].app_id | string | Yes | |
categories[].key | string | Yes | |
categories[].name | map<string, string> | Yes | |
categories[].description | map<string, string> | Yes | |
categories[].channels | array<string> | null | Yes | |
categories[].default_opted_in | boolean | Yes | |
categories[].position | integer | Yes | |
categories[].opted_out_users | integer | Yes | |
categories[].created_at | string | Yes | |
categories[].updated_at | string | Yes | |
consents | array<object> | Yes | |
consents[].purpose | enum | Yes | Values: "ads_personalization" |
consents[].granted | boolean | Yes | |
consents[].source | string | null | Yes | |
consents[].updated_at | string | null | Yes |
Example response:
{
"data": [
{
"channel": "web_push",
"category": "örnek",
"opted_in": true,
"explicit": true,
"source": "örnek",
"updated_at": "örnek"
}
],
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"categories": [
{
"name": {
"key": "user_42"
},
"channels": [
"web_push"
],
"id": "cat_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"key": "key-2026-10",
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1,
"opted_out_users": 1,
"created_at": "örnek",
"updated_at": "örnek"
}
],
"consents": [
{
"purpose": "ads_personalization",
"granted": true,
"source": "ö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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/preferences" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Write user preferences (by alias)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
label | path | string | Yes | "external_id" | |
value | path | string | Yes | "user_42" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SetPreferencesDto
| Field | Type | Required | Description |
|---|---|---|---|
preferences | array<object> | Yes | Items: 1–100 |
preferences[].category | string | Yes | Length: 1–64 |
preferences[].channel | enum | null | No | |
preferences[].opted_in | boolean | Yes |
Example:
{
"preferences": [
{
"category": "örnek",
"opted_in": true,
"channel": "ios_push"
}
]
}Responses
200 — Success.
Schema: UserPreferences
| Field | Type | Required | Description |
|---|---|---|---|
user_id | string | Yes | |
data | array<object> | Yes | |
data[].category | string | Yes | |
data[].channel | string | null | Yes | |
data[].opted_in | boolean | Yes | |
data[].explicit | boolean | Yes | |
data[].source | string | null | Yes | |
data[].updated_at | string | null | Yes | |
categories | array<object> | Yes | |
categories[].id | string | Yes | |
categories[].app_id | string | Yes | |
categories[].key | string | Yes | |
categories[].name | map<string, string> | Yes | |
categories[].description | map<string, string> | Yes | |
categories[].channels | array<string> | null | Yes | |
categories[].default_opted_in | boolean | Yes | |
categories[].position | integer | Yes | |
categories[].opted_out_users | integer | Yes | |
categories[].created_at | string | Yes | |
categories[].updated_at | string | Yes | |
consents | array<object> | Yes | |
consents[].purpose | enum | Yes | Values: "ads_personalization" |
consents[].granted | boolean | Yes | |
consents[].source | string | null | Yes | |
consents[].updated_at | string | null | Yes |
Example response:
{
"data": [
{
"channel": "web_push",
"category": "örnek",
"opted_in": true,
"explicit": true,
"source": "örnek",
"updated_at": "örnek"
}
],
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"categories": [
{
"name": {
"key": "user_42"
},
"channels": [
"web_push"
],
"id": "cat_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"key": "key-2026-10",
"description": {
"key": "user_42"
},
"default_opted_in": true,
"position": 1,
"opted_out_users": 1,
"created_at": "örnek",
"updated_at": "örnek"
}
],
"consents": [
{
"purpose": "ads_personalization",
"granted": true,
"source": "ö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 PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/preferences" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"preferences": [
{
"category": "örnek",
"opted_in": true,
"channel": "ios_push"
}
]
}'Notification inbox and inbox settings
Notification inbox and inbox settings — 21 operations (GET /v1/apps/{appId}/canned-responses, POST /v1/apps/{appId}/canned-responses, PATCH /v1/apps/{appId}/canned-responses/{cannedId}, …). Generated from the OpenAPI 3.1.0 contract.
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.