Users and subscriptions
Users and subscriptions — 35 operations (GET /v1/apps/{appId}/companies, POST /v1/apps/{appId}/companies, POST /v1/apps/{appId}/companies/batch, …). Generated from the OpenAPI 3.1.0 contract.
Create/update end users, aliases, subscriptions (device, email, phone), search, KVKK/GDPR export and deletion, and event ingestion.
Base URL: https://api.pushizo.com · Tag: users · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/companies | List companies |
POST | /v1/apps/{appId}/companies | Create or update a company (by external_id) |
POST | /v1/apps/{appId}/companies/batch | Bulk create or update companies |
GET | /v1/apps/{appId}/companies/{companyId} | Get a company |
PATCH | /v1/apps/{appId}/companies/{companyId} | Update a company |
DELETE | /v1/apps/{appId}/companies/{companyId} | Delete a company |
GET | /v1/apps/{appId}/companies/{companyId}/members | List company members |
POST | /v1/apps/{appId}/companies/{companyId}/members/batch | Add members to a company in bulk |
PUT | /v1/apps/{appId}/companies/{companyId}/members/{userId} | Add a user to a company or change their role |
DELETE | /v1/apps/{appId}/companies/{companyId}/members/{userId} | Remove a user from a company |
GET | /v1/apps/{appId}/users/{userId}/companies | List a user's companies |
GET | /v1/apps/{appId}/users/by/{label}/{value}/companies | List a user's companies (by external_id or alias) |
GET | /v1/apps/{appId}/users | List users |
POST | /v1/apps/{appId}/users | Create/update a user (by external_id, optionally with subscriptions) |
POST | /v1/apps/{appId}/users/search | Search users with a segment definition |
GET | /v1/apps/{appId}/users/by/{label}/{value} | User by alias (hs_id, external_id or a custom label) |
PATCH | /v1/apps/{appId}/users/by/{label}/{value} | Tag/property merge-patch and deltas |
DELETE | /v1/apps/{appId}/users/by/{label}/{value} | Delete a user (subscriptions are deleted, events are anonymized) |
GET | /v1/apps/{appId}/users/by/{label}/{value}/identity | All identities of the user (hs_id, external_id, custom aliases) |
PATCH | /v1/apps/{appId}/users/by/{label}/{value}/identity | Add an alias |
GET | /v1/apps/{appId}/users/by/{label}/{value}/export | Export user data (KVKK/GDPR portability): profile, aliases, subscriptions, recent events |
GET | /v1/apps/{appId}/users/by/{label}/{value}/timeline | The user's event and delivery timeline (newest 40 entries) |
GET | /v1/apps/{appId}/users/by/{label}/{value}/events | The user's recent events |
GET | /v1/apps/{appId}/users/by/{label}/{value}/messages | The user's recent messages (deliveries, newest first) |
DELETE | /v1/apps/{appId}/users/by/{label}/{value}/identity/{aliasLabel} | Remove an alias |
POST | /v1/apps/{appId}/users/by/{label}/{value}/subscriptions | Add a subscription to the user |
GET | /v1/apps/{appId}/subscriptions | List subscriptions (channel/status/test device filters; only the last 8 characters of the token are returned) |
POST | /v1/apps/{appId}/subscriptions/cleanup | Bulk cleanup: delete invalid (or unsubscribed) subscriptions |
GET | /v1/apps/{appId}/subscriptions/{subscriptionId} | Subscription details |
PATCH | /v1/apps/{appId}/subscriptions/{subscriptionId} | Update a subscription |
DELETE | /v1/apps/{appId}/subscriptions/{subscriptionId} | Delete a subscription |
GET | /v1/apps/{appId}/subscriptions/{subscriptionId}/user/identity | Identities of the user who owns the subscription |
PATCH | /v1/apps/{appId}/subscriptions_by_token/{tokenType}/{token} | Update a subscription by token (token_type: ios_push, android_push, hms_push, web_push, email, sms or the legacy provider names iOSPush, AndroidPush, HuaweiPush, ChromePush, FirefoxPush, SafariPush, Email, SMS) |
POST | /v1/apps/{appId}/subscriptions/{subscriptionId}/owner | Link the subscription to a user by external_id |
POST | /v1/apps/{appId}/events | Send events in bulk (up to 500) |
Details
List companies
Searches name, external ID or domain; newest first.
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…" |
q | query | string | No | Length: 1–200 | "ayse" |
external_id | query | string | No | "user_42" | |
domain | query | string | No | Length: 1–253 | "örnek" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CompanyList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].external_id | string | Yes | |
data[].name | string | null | Yes | |
data[].domain | string | null | Yes | |
data[].properties | map<string, any> | Yes | |
data[].member_count | integer | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"domain": "örnek",
"member_count": 1,
"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/companies?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create or update a company (by external_id)
If the external_id already exists, name, domain and properties are updated; properties are merge-patched (null removes a key).
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: UpsertCompanyDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | |
name | string | null | No | |
domain | string | null | No | |
properties | map<string, any> | No |
Example:
{
"external_id": "user_42",
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"domain": "örnek"
}Responses
201 — Success.
Schema: Company
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
external_id | string | Yes | |
name | string | null | Yes | |
domain | string | null | Yes | |
properties | map<string, any> | Yes | |
member_count | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"domain": "örnek",
"member_count": 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/companies" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"external_id": "user_42",
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"domain": "örnek"
}'Bulk create or update companies
Up to 1000 companies per request; each is upserted by external_id.
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: BatchUpsertCompaniesDto
| Field | Type | Required | Description |
|---|---|---|---|
companies | array<object> | Yes | Items: 1–1000 |
companies[].external_id | string | Yes | |
companies[].name | string | null | No | |
companies[].domain | string | null | No | |
companies[].properties | map<string, any> | No |
Example:
{
"companies": [
{
"external_id": "user_42",
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"domain": "örnek"
}
]
}Responses
200 — Success.
Schema: CompanyBatchResult
| Field | Type | Required | Description |
|---|---|---|---|
created | integer | Yes | |
updated | integer | Yes | |
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].external_id | string | Yes | |
data[].created | boolean | Yes |
Example response:
{
"data": [
{
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"created": true
}
],
"created": 1,
"updated": 1
}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/companies/batch" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"companies": [
{
"external_id": "user_42",
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"domain": "örnek"
}
]
}'Get a company
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
companyId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Company
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
external_id | string | Yes | |
name | string | null | Yes | |
domain | string | null | Yes | |
properties | map<string, any> | Yes | |
member_count | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"domain": "örnek",
"member_count": 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/companies/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a company
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
companyId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateCompanyDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | No | |
name | string | null | No | |
domain | string | null | No | |
properties | map<string, any> | No |
Example:
{
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"external_id": "user_42",
"domain": "örnek"
}Responses
200 — Success.
Schema: Company
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
external_id | string | Yes | |
name | string | null | Yes | |
domain | string | null | Yes | |
properties | map<string, any> | Yes | |
member_count | integer | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"domain": "örnek",
"member_count": 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/companies/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"external_id": "user_42",
"domain": "örnek"
}'Delete a company
Memberships are removed; users are kept.
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
companyId | path | string | Yes | "usr_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/companies/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"List company members
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
companyId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
role | query | string | No | "değer" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: CompanyMemberList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].company_id | string | Yes | |
data[].user_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].role | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"company_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"role": "ö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/companies/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/members?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Add members to a company in bulk
Each user is given by user_id or by the user's external_id; users that are not found are listed in the response.
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
companyId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: BatchMembersDto
| Field | Type | Required | Description |
|---|---|---|---|
members | array<object> | Yes | Items: 1–1000 |
members[].user_id | string | No | Length: 1–64 |
members[].external_id | string | No | Length: 1–255 |
members[].role | string | No |
Example:
{
"members": [
{
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"role": "değer"
}
]
}Responses
200 — Success.
Schema: CompanyMemberBatchResult
| Field | Type | Required | Description |
|---|---|---|---|
added | integer | Yes | |
updated | integer | Yes | |
not_found | array<object> | Yes | |
not_found[].index | integer | Yes | |
not_found[].user_id | string | null | Yes | |
not_found[].external_id | string | null | Yes |
Example response:
{
"added": 1,
"updated": 1,
"not_found": [
{
"index": 1,
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42"
}
]
}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/companies/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/members/batch" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"members": [
{
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"role": "değer"
}
]
}'Add a user to a company or change their role
Without a role, a new membership becomes member and an existing membership keeps its role.
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
companyId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SetMemberDto
| Field | Type | Required | Description |
|---|---|---|---|
role | string | No |
Example:
{
"role": "değer"
}Responses
200 — Success.
Schema: CompanyMember
| Field | Type | Required | Description |
|---|---|---|---|
company_id | string | Yes | |
user_id | string | Yes | |
external_id | string | null | Yes | |
role | string | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"company_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"role": "ö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 PUT "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/companies/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/members/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"role": "değer"
}'Remove a user from a company
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
companyId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
userId | path | string | Yes | "usr_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/companies/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/members/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"List a user's companies
Most recently linked company first (this is the company used by company in templates).
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
userId | path | string | Yes | "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UserCompanyList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].company | object | Yes | |
data[].company.id | string | Yes | |
data[].company.external_id | string | Yes | |
data[].company.name | string | null | Yes | |
data[].company.domain | string | null | Yes | |
data[].company.properties | map<string, any> | Yes | |
data[].role | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"company": {
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"domain": "örnek"
},
"role": "ö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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/usr_01JD3W5Q7X9K2M4N6P8R0T1V3W/companies" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"List a user's companies (by external_id or alias)
label: hs_id, external_id or a custom alias label.
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: UserCompanyList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].company | object | Yes | |
data[].company.id | string | Yes | |
data[].company.external_id | string | Yes | |
data[].company.name | string | null | Yes | |
data[].company.domain | string | null | Yes | |
data[].company.properties | map<string, any> | Yes | |
data[].role | string | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"company": {
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"domain": "örnek"
},
"role": "ö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 GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42/companies" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"List users
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…" |
sort | query | enum | No | Values: "last_active_at", "-last_active_at" | "last_active_at" |
q | query | string | No | Length: 1–255 | "ayse" |
ip | query | string | No | Length: 2–64 | "örnek" |
tag | query | string | No | Length: 3–320 | "plan:pro" |
last_active_after | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
last_active_before | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UserList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].properties | map<string, any> | Yes | |
data[].tags | map<string, string> | Yes | |
data[].first_seen_at | string | Yes | |
data[].last_active_at | string | Yes | |
data[].session_count | integer | Yes | |
data[].usage_seconds | integer | Yes | |
data[].merged_into | string | null | Yes | |
data[].last_ip | string | null | Yes | |
data[].last_ip_at | string | null | Yes | |
data[].last_sentiment | enum | null | Yes | |
data[].last_sentiment_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].subscription_count | integer | Yes | |
data[].channels | array<enum> | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"channels": [
"ios_push"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"first_seen_at": "örnek",
"last_active_at": "örnek",
"session_count": 1,
"usage_seconds": 1,
"merged_into": "örnek",
"last_ip": "örnek",
"last_ip_at": "örnek",
"last_sentiment": "positive",
"last_sentiment_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"subscription_count": 1
}
],
"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/users?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create/update a user (by external_id, optionally with subscriptions)
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
Idempotency-Key | header | string | No | A request repeated with the same key within 24 hours returns the same response. | "order-1001" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpsertUserDto
| Field | Type | Required | Description |
|---|---|---|---|
identity | object | No | |
identity.external_id | string | Yes | Length: 1–255 |
external_id | string | No | Length: 1–255 |
properties | map<string, any> | No | |
tags | map<string, string> | No | |
subscriptions | array<object> | No | Items: 0–20 |
subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
subscriptions[].token | string | Yes | Length: 1–4096 |
subscriptions[].device | object | No | Default: {} |
subscriptions[].device.model | string | No | Length: 0–100 |
subscriptions[].device.os | string | No | Length: 0–50 |
subscriptions[].device.os_version | string | No | Length: 0–50 |
subscriptions[].device.app_version | string | null | No | |
subscriptions[].device.sdk_version | string | No | Length: 0–50 |
subscriptions[].device.sdk_platform | string | No | Length: 0–50 |
subscriptions[].device.carrier | string | No | Length: 0–100 |
subscriptions[].device.locale | string | No | Length: 0–20 |
subscriptions[].device.timezone | string | No | Length: 0–64 |
subscriptions[].device.push_capable | boolean | No | |
subscriptions[].device.push_environment | enum | No | Values: "sandbox", "production" |
subscriptions[].device.form_factor | enum | No | Values: "phone", "watch" |
subscriptions[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
subscriptions[].device.manufacturer | string | No | Length: 0–50 |
subscriptions[].device.brand | string | No | Length: 0–50 |
subscriptions[].device.rom | string | No | Length: 0–30 |
subscriptions[].device.rom_version | string | No | Length: 0–30 |
subscriptions[].device.delivery | object | No | |
subscriptions[].device.delivery.battery_optimization_exempt | boolean | No | |
subscriptions[].device.delivery.background_restricted | boolean | No | |
subscriptions[].device.delivery.channel_blocked | boolean | No | |
subscriptions[].device.delivery.power_save_mode | boolean | No | |
subscriptions[].device.delivery.data_saver | boolean | No | |
subscriptions[].device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
subscriptions[].status | enum | No | Values: "subscribed", "unsubscribed" |
subscriptions[].opt_in | object | No | |
subscriptions[].opt_in.source | string | Yes | Length: 1–100 |
subscriptions[].opt_in.at | string (date-time) | No |
Example:
{
"identity": {
"external_id": "user_42"
},
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"subscriptions": [
{
"channel": "ios_push",
"token": "d1f2e3…",
"status": "subscribed",
"device": {},
"opt_in": {
"source": "örnek",
"at": "2026-10-17T09:00:00Z"
}
}
],
"external_id": "user_42"
}Responses
201 — Success.
Schema: UserDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
external_id | string | null | Yes | |
properties | map<string, any> | Yes | |
tags | map<string, string> | Yes | |
first_seen_at | string | Yes | |
last_active_at | string | Yes | |
session_count | integer | Yes | |
usage_seconds | integer | Yes | |
merged_into | string | null | Yes | |
last_ip | string | null | Yes | |
last_ip_at | string | null | Yes | |
last_sentiment | enum | null | Yes | |
last_sentiment_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
subscription_count | integer | Yes | |
channels | array<enum> | Yes | |
aliases | array<object> | Yes | |
aliases[].label | string | Yes | |
aliases[].value | string | Yes | |
subscriptions | array<object> | Yes | |
subscriptions[].id | string | Yes | |
subscriptions[].app_id | string | Yes | |
subscriptions[].user_id | string | null | Yes | |
subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
subscriptions[].token | string | Yes | |
subscriptions[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
subscriptions[].unsubscribe_reason | enum | null | Yes | |
subscriptions[].device | object | Yes | |
subscriptions[].device.model | string | No | Length: 0–100 |
subscriptions[].device.os | string | No | Length: 0–50 |
subscriptions[].device.os_version | string | No | Length: 0–50 |
subscriptions[].device.app_version | string | null | No | |
subscriptions[].device.sdk_version | string | No | Length: 0–50 |
subscriptions[].device.sdk_platform | string | No | Length: 0–50 |
subscriptions[].device.carrier | string | No | Length: 0–100 |
subscriptions[].device.locale | string | No | Length: 0–20 |
subscriptions[].device.timezone | string | No | Length: 0–64 |
subscriptions[].device.push_capable | boolean | No | |
subscriptions[].device.push_environment | enum | No | Values: "sandbox", "production" |
subscriptions[].device.form_factor | enum | No | Values: "phone", "watch" |
subscriptions[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
subscriptions[].device.manufacturer | string | No | Length: 0–50 |
subscriptions[].device.brand | string | No | Length: 0–50 |
subscriptions[].device.rom | string | No | Length: 0–30 |
subscriptions[].device.rom_version | string | No | Length: 0–30 |
subscriptions[].device.delivery | object | No | |
subscriptions[].test_device | boolean | Yes | |
subscriptions[].test_device_name | string | null | Yes | |
subscriptions[].last_active_at | string | Yes | |
subscriptions[].last_sent_at | string | null | Yes | |
subscriptions[].last_delivered_at | string | null | Yes | |
subscriptions[].opted_in_at | string | null | Yes | |
subscriptions[].opt_in_source | string | null | Yes | |
subscriptions[].unsubscribed_at | string | null | Yes | |
subscriptions[].location | object | null | Yes | |
subscriptions[].created_at | string | Yes |
Example response:
{
"channels": [
"ios_push"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"subscriptions": [
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_at": "örnek"
}
],
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"first_seen_at": "örnek",
"last_active_at": "örnek",
"session_count": 1,
"usage_seconds": 1,
"merged_into": "örnek",
"last_ip": "örnek",
"last_ip_at": "örnek",
"last_sentiment": "positive",
"last_sentiment_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"subscription_count": 1,
"aliases": [
{
"label": "external_id",
"value": "user_42"
}
]
}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/users" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Idempotency-Key: order-1001" \
-H "Content-Type: application/json" \
-d '{
"identity": {
"external_id": "user_42"
},
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"subscriptions": [
{
"channel": "ios_push",
"token": "d1f2e3…",
"status": "subscribed",
"device": {},
"opt_in": {
"source": "örnek",
"at": "2026-10-17T09:00:00Z"
}
}
],
"external_id": "user_42"
}'Search users with a segment definition
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
| Field | Type | Required | Description |
|---|---|---|---|
definition | object | Yes | Filter AST: all/any/none groups and { field, op, value } conditions (docs/plan/05 §5.7). |
definition.all | array<object> | No | |
definition.any | array<object> | No | |
definition.none | array<object> | No | |
limit | integer | No | Default: 50; Range: 1–200 |
cursor | string | No |
Example:
{
"definition": {
"all": [
{}
],
"any": [
{}
],
"none": [
{}
]
},
"limit": 50,
"cursor": "eyJpZCI6Im1zZ18wMUpE…"
}Responses
200 — Success.
Schema: UserList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].external_id | string | null | Yes | |
data[].properties | map<string, any> | Yes | |
data[].tags | map<string, string> | Yes | |
data[].first_seen_at | string | Yes | |
data[].last_active_at | string | Yes | |
data[].session_count | integer | Yes | |
data[].usage_seconds | integer | Yes | |
data[].merged_into | string | null | Yes | |
data[].last_ip | string | null | Yes | |
data[].last_ip_at | string | null | Yes | |
data[].last_sentiment | enum | null | Yes | |
data[].last_sentiment_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes | |
data[].subscription_count | integer | Yes | |
data[].channels | array<enum> | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"channels": [
"ios_push"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"first_seen_at": "örnek",
"last_active_at": "örnek",
"session_count": 1,
"usage_seconds": 1,
"merged_into": "örnek",
"last_ip": "örnek",
"last_ip_at": "örnek",
"last_sentiment": "positive",
"last_sentiment_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"subscription_count": 1
}
],
"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 POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/search" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"definition": {
"all": [
{}
],
"any": [
{}
],
"none": [
{}
]
},
"limit": 50,
"cursor": "eyJpZCI6Im1zZ18wMUpE…"
}'User by alias (hs_id, external_id or a custom label)
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: UserDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
external_id | string | null | Yes | |
properties | map<string, any> | Yes | |
tags | map<string, string> | Yes | |
first_seen_at | string | Yes | |
last_active_at | string | Yes | |
session_count | integer | Yes | |
usage_seconds | integer | Yes | |
merged_into | string | null | Yes | |
last_ip | string | null | Yes | |
last_ip_at | string | null | Yes | |
last_sentiment | enum | null | Yes | |
last_sentiment_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
subscription_count | integer | Yes | |
channels | array<enum> | Yes | |
aliases | array<object> | Yes | |
aliases[].label | string | Yes | |
aliases[].value | string | Yes | |
subscriptions | array<object> | Yes | |
subscriptions[].id | string | Yes | |
subscriptions[].app_id | string | Yes | |
subscriptions[].user_id | string | null | Yes | |
subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
subscriptions[].token | string | Yes | |
subscriptions[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
subscriptions[].unsubscribe_reason | enum | null | Yes | |
subscriptions[].device | object | Yes | |
subscriptions[].device.model | string | No | Length: 0–100 |
subscriptions[].device.os | string | No | Length: 0–50 |
subscriptions[].device.os_version | string | No | Length: 0–50 |
subscriptions[].device.app_version | string | null | No | |
subscriptions[].device.sdk_version | string | No | Length: 0–50 |
subscriptions[].device.sdk_platform | string | No | Length: 0–50 |
subscriptions[].device.carrier | string | No | Length: 0–100 |
subscriptions[].device.locale | string | No | Length: 0–20 |
subscriptions[].device.timezone | string | No | Length: 0–64 |
subscriptions[].device.push_capable | boolean | No | |
subscriptions[].device.push_environment | enum | No | Values: "sandbox", "production" |
subscriptions[].device.form_factor | enum | No | Values: "phone", "watch" |
subscriptions[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
subscriptions[].device.manufacturer | string | No | Length: 0–50 |
subscriptions[].device.brand | string | No | Length: 0–50 |
subscriptions[].device.rom | string | No | Length: 0–30 |
subscriptions[].device.rom_version | string | No | Length: 0–30 |
subscriptions[].device.delivery | object | No | |
subscriptions[].test_device | boolean | Yes | |
subscriptions[].test_device_name | string | null | Yes | |
subscriptions[].last_active_at | string | Yes | |
subscriptions[].last_sent_at | string | null | Yes | |
subscriptions[].last_delivered_at | string | null | Yes | |
subscriptions[].opted_in_at | string | null | Yes | |
subscriptions[].opt_in_source | string | null | Yes | |
subscriptions[].unsubscribed_at | string | null | Yes | |
subscriptions[].location | object | null | Yes | |
subscriptions[].created_at | string | Yes |
Example response:
{
"channels": [
"ios_push"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"subscriptions": [
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_at": "örnek"
}
],
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"first_seen_at": "örnek",
"last_active_at": "örnek",
"session_count": 1,
"usage_seconds": 1,
"merged_into": "örnek",
"last_ip": "örnek",
"last_ip_at": "örnek",
"last_sentiment": "positive",
"last_sentiment_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"subscription_count": 1,
"aliases": [
{
"label": "external_id",
"value": "user_42"
}
]
}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" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Tag/property merge-patch and deltas
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: PatchUserDto
| Field | Type | Required | Description |
|---|---|---|---|
properties | map<string, any> | No | |
tags | map<string, string | null> | No | |
deltas | object | No | |
deltas.session_count | integer | No | Range: -1000000–1000000 |
deltas.session_time | integer | No | Range: 0–31536000 |
deltas.purchases | array<object> | No | Items: 0–100 |
deltas.purchases[].sku | string | Yes | Length: 1–100 |
deltas.purchases[].amount | number | Yes | Range: 0–∞ |
deltas.purchases[].iso | string | No | Length: 3–3 |
deltas.purchases[].count | integer | No | Default: 1; Range: 1–1000 |
Example:
{
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"deltas": {
"session_count": 1,
"session_time": 1,
"purchases": [
{
"sku": "örnek",
"amount": 149.9,
"iso": "örnek"
}
]
}
}Responses
200 — Success.
Schema: UserDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
external_id | string | null | Yes | |
properties | map<string, any> | Yes | |
tags | map<string, string> | Yes | |
first_seen_at | string | Yes | |
last_active_at | string | Yes | |
session_count | integer | Yes | |
usage_seconds | integer | Yes | |
merged_into | string | null | Yes | |
last_ip | string | null | Yes | |
last_ip_at | string | null | Yes | |
last_sentiment | enum | null | Yes | |
last_sentiment_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
subscription_count | integer | Yes | |
channels | array<enum> | Yes | |
aliases | array<object> | Yes | |
aliases[].label | string | Yes | |
aliases[].value | string | Yes | |
subscriptions | array<object> | Yes | |
subscriptions[].id | string | Yes | |
subscriptions[].app_id | string | Yes | |
subscriptions[].user_id | string | null | Yes | |
subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
subscriptions[].token | string | Yes | |
subscriptions[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
subscriptions[].unsubscribe_reason | enum | null | Yes | |
subscriptions[].device | object | Yes | |
subscriptions[].device.model | string | No | Length: 0–100 |
subscriptions[].device.os | string | No | Length: 0–50 |
subscriptions[].device.os_version | string | No | Length: 0–50 |
subscriptions[].device.app_version | string | null | No | |
subscriptions[].device.sdk_version | string | No | Length: 0–50 |
subscriptions[].device.sdk_platform | string | No | Length: 0–50 |
subscriptions[].device.carrier | string | No | Length: 0–100 |
subscriptions[].device.locale | string | No | Length: 0–20 |
subscriptions[].device.timezone | string | No | Length: 0–64 |
subscriptions[].device.push_capable | boolean | No | |
subscriptions[].device.push_environment | enum | No | Values: "sandbox", "production" |
subscriptions[].device.form_factor | enum | No | Values: "phone", "watch" |
subscriptions[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
subscriptions[].device.manufacturer | string | No | Length: 0–50 |
subscriptions[].device.brand | string | No | Length: 0–50 |
subscriptions[].device.rom | string | No | Length: 0–30 |
subscriptions[].device.rom_version | string | No | Length: 0–30 |
subscriptions[].device.delivery | object | No | |
subscriptions[].test_device | boolean | Yes | |
subscriptions[].test_device_name | string | null | Yes | |
subscriptions[].last_active_at | string | Yes | |
subscriptions[].last_sent_at | string | null | Yes | |
subscriptions[].last_delivered_at | string | null | Yes | |
subscriptions[].opted_in_at | string | null | Yes | |
subscriptions[].opt_in_source | string | null | Yes | |
subscriptions[].unsubscribed_at | string | null | Yes | |
subscriptions[].location | object | null | Yes | |
subscriptions[].created_at | string | Yes |
Example response:
{
"channels": [
"ios_push"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"subscriptions": [
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_at": "örnek"
}
],
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"first_seen_at": "örnek",
"last_active_at": "örnek",
"session_count": 1,
"usage_seconds": 1,
"merged_into": "örnek",
"last_ip": "örnek",
"last_ip_at": "örnek",
"last_sentiment": "positive",
"last_sentiment_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"subscription_count": 1,
"aliases": [
{
"label": "external_id",
"value": "user_42"
}
]
}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/users/by/external_id/user_42" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"deltas": {
"session_count": 1,
"session_time": 1,
"purchases": [
{
"sku": "örnek",
"amount": 149.9,
"iso": "örnek"
}
]
}
}'Delete a user (subscriptions are deleted, events are anonymized)
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" |
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/users/by/external_id/user_42" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"All identities of the user (hs_id, external_id, custom aliases)
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: UserIdentity
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes |
Example response:
{
"identity": {
"external_id": [
"user_42"
]
}
}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/identity" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Add an 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: AddAliasDto
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes |
Example:
{
"identity": {
"external_id": [
"user_42"
]
}
}Responses
200 — Success.
Schema: UserDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
external_id | string | null | Yes | |
properties | map<string, any> | Yes | |
tags | map<string, string> | Yes | |
first_seen_at | string | Yes | |
last_active_at | string | Yes | |
session_count | integer | Yes | |
usage_seconds | integer | Yes | |
merged_into | string | null | Yes | |
last_ip | string | null | Yes | |
last_ip_at | string | null | Yes | |
last_sentiment | enum | null | Yes | |
last_sentiment_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
subscription_count | integer | Yes | |
channels | array<enum> | Yes | |
aliases | array<object> | Yes | |
aliases[].label | string | Yes | |
aliases[].value | string | Yes | |
subscriptions | array<object> | Yes | |
subscriptions[].id | string | Yes | |
subscriptions[].app_id | string | Yes | |
subscriptions[].user_id | string | null | Yes | |
subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
subscriptions[].token | string | Yes | |
subscriptions[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
subscriptions[].unsubscribe_reason | enum | null | Yes | |
subscriptions[].device | object | Yes | |
subscriptions[].device.model | string | No | Length: 0–100 |
subscriptions[].device.os | string | No | Length: 0–50 |
subscriptions[].device.os_version | string | No | Length: 0–50 |
subscriptions[].device.app_version | string | null | No | |
subscriptions[].device.sdk_version | string | No | Length: 0–50 |
subscriptions[].device.sdk_platform | string | No | Length: 0–50 |
subscriptions[].device.carrier | string | No | Length: 0–100 |
subscriptions[].device.locale | string | No | Length: 0–20 |
subscriptions[].device.timezone | string | No | Length: 0–64 |
subscriptions[].device.push_capable | boolean | No | |
subscriptions[].device.push_environment | enum | No | Values: "sandbox", "production" |
subscriptions[].device.form_factor | enum | No | Values: "phone", "watch" |
subscriptions[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
subscriptions[].device.manufacturer | string | No | Length: 0–50 |
subscriptions[].device.brand | string | No | Length: 0–50 |
subscriptions[].device.rom | string | No | Length: 0–30 |
subscriptions[].device.rom_version | string | No | Length: 0–30 |
subscriptions[].device.delivery | object | No | |
subscriptions[].test_device | boolean | Yes | |
subscriptions[].test_device_name | string | null | Yes | |
subscriptions[].last_active_at | string | Yes | |
subscriptions[].last_sent_at | string | null | Yes | |
subscriptions[].last_delivered_at | string | null | Yes | |
subscriptions[].opted_in_at | string | null | Yes | |
subscriptions[].opt_in_source | string | null | Yes | |
subscriptions[].unsubscribed_at | string | null | Yes | |
subscriptions[].location | object | null | Yes | |
subscriptions[].created_at | string | Yes |
Example response:
{
"channels": [
"ios_push"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"subscriptions": [
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_at": "örnek"
}
],
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"first_seen_at": "örnek",
"last_active_at": "örnek",
"session_count": 1,
"usage_seconds": 1,
"merged_into": "örnek",
"last_ip": "örnek",
"last_ip_at": "örnek",
"last_sentiment": "positive",
"last_sentiment_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"subscription_count": 1,
"aliases": [
{
"label": "external_id",
"value": "user_42"
}
]
}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/users/by/external_id/user_42/identity" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"identity": {
"external_id": [
"user_42"
]
}
}'Export user data (KVKK/GDPR portability): profile, aliases, subscriptions, recent events
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: UserExport
| Field | Type | Required | Description |
|---|---|---|---|
exported_at | string | Yes | |
user | object | Yes | |
user.id | string | Yes | |
user.app_id | string | Yes | |
user.external_id | string | null | Yes | |
user.properties | map<string, any> | Yes | |
user.tags | map<string, string> | Yes | |
user.first_seen_at | string | Yes | |
user.last_active_at | string | Yes | |
user.session_count | integer | Yes | |
user.usage_seconds | integer | Yes | |
user.merged_into | string | null | Yes | |
user.last_ip | string | null | Yes | |
user.last_ip_at | string | null | Yes | |
user.last_sentiment | enum | null | Yes | |
user.last_sentiment_at | string | null | Yes | |
user.created_at | string | Yes | |
user.updated_at | string | Yes | |
user.subscription_count | integer | Yes | |
user.channels | array<enum> | Yes | |
user.aliases | array<object> | Yes | |
user.aliases[].label | string | Yes | |
user.aliases[].value | string | Yes | |
user.subscriptions | array<object> | Yes | |
user.subscriptions[].id | string | Yes | |
user.subscriptions[].app_id | string | Yes | |
user.subscriptions[].user_id | string | null | Yes | |
user.subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
user.subscriptions[].token | string | Yes | |
user.subscriptions[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
user.subscriptions[].unsubscribe_reason | enum | null | Yes | |
user.subscriptions[].device | object | Yes | |
user.subscriptions[].test_device | boolean | Yes | |
user.subscriptions[].test_device_name | string | null | Yes | |
user.subscriptions[].last_active_at | string | Yes | |
user.subscriptions[].last_sent_at | string | null | Yes | |
user.subscriptions[].last_delivered_at | string | null | Yes | |
user.subscriptions[].opted_in_at | string | null | Yes | |
user.subscriptions[].opt_in_source | string | null | Yes | |
user.subscriptions[].unsubscribed_at | string | null | Yes | |
user.subscriptions[].location | object | null | Yes | |
user.subscriptions[].created_at | string | Yes | |
events | array<object> | Yes | |
events[].id | string | Yes | |
events[].user_id | string | null | Yes | |
events[].subscription_id | string | null | Yes | |
events[].name | string | Yes | |
events[].properties | map<string, any> | Yes | |
events[].value | number | null | Yes | |
events[].source | enum | Yes | Values: "sdk", "api", "system", "import" |
events[].occurred_at | string | Yes | |
derived | object | Yes | |
derived.wallet_passes | array<object> | Yes | |
derived.wallet_passes[].id | string | Yes | |
derived.wallet_passes[].template_id | string | Yes | |
derived.wallet_passes[].status | string | Yes | |
derived.wallet_passes[].barcode_value | string | Yes | |
derived.wallet_passes[].values | map<string, string> | Yes | |
derived.wallet_passes[].created_at | string | Yes | |
derived.wallet_passes[].updated_at | string | Yes | |
derived.rfm | object | null | Yes | |
derived.predictions | array<object> | Yes | |
derived.predictions[].model | string | Yes | |
derived.predictions[].score | number | Yes | |
derived.predictions[].computed_at | string | Yes | |
derived.channel_scores | array<object> | Yes | |
derived.channel_scores[].channel | string | Yes | |
derived.channel_scores[].sends | number | Yes | |
derived.channel_scores[].engaged | number | Yes | |
derived.channel_scores[].score | number | Yes | |
derived.channel_scores[].is_best | boolean | Yes | |
derived.channel_scores[].computed_at | string | Yes | |
derived.decisions | array<object> | Yes | |
derived.decisions[].agent | string | Yes | |
derived.decisions[].arm_id | string | Yes | |
derived.decisions[].context | string | Yes | |
derived.decisions[].assigned_at | string | Yes | |
derived.decisions[].rewarded_at | string | null | Yes | |
derived.recommendations | array<object> | Yes | |
derived.recommendations[].catalog_id | string | Yes | |
derived.recommendations[].personalized | array<string> | Yes | |
derived.recommendations[].recent | array<string> | Yes | |
derived.recommendations[].purchased | array<string> | Yes | |
derived.recommendations[].computed_at | string | Yes | |
derived.affinities | array<object> | Yes | |
derived.affinities[].attribute | string | Yes | |
derived.affinities[].value | string | Yes | |
derived.affinities[].score | number | Yes | |
derived.affinities[].rank | number | Yes | |
derived.affinities[].computed_at | string | Yes | |
derived.frequency_cap | object | null | Yes | |
derived.companies | array<object> | Yes | |
derived.companies[].company_id | string | Yes | |
derived.companies[].external_id | string | Yes | |
derived.companies[].name | string | null | Yes | |
derived.companies[].role | string | Yes | |
derived.companies[].joined_at | string | Yes |
Example response:
{
"events": [
{
"name": "purchase",
"properties": {
"order_id": "1001"
},
"id": "evt_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"value": 149.9,
"source": "sdk",
"occurred_at": "örnek"
}
],
"exported_at": "örnek",
"user": {
"channels": [
"ios_push"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"subscriptions": [
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_at": "örnek"
}
],
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"first_seen_at": "örnek",
"last_active_at": "örnek",
"session_count": 1,
"usage_seconds": 1,
"merged_into": "örnek",
"last_ip": "örnek",
"last_ip_at": "örnek",
"last_sentiment": "positive",
"last_sentiment_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"subscription_count": 1,
"aliases": [
{
"label": "external_id",
"value": "user_42"
}
]
},
"derived": {
"wallet_passes": [
{
"status": "örnek",
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"template_id": "tpl_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"barcode_value": "örnek",
"values": {
"key": "user_42"
},
"created_at": "örnek",
"updated_at": "örnek"
}
],
"rfm": {
"segment": "örnek",
"segment_since": "örnek",
"r": 1.5,
"f": 1.5,
"m": 1.5,
"frequency": 1.5,
"monetary": 1.5,
"last_event_at": "örnek",
"computed_at": "örnek"
},
"predictions": [
{
"model": "örnek",
"score": 1.5,
"computed_at": "örnek"
}
],
"channel_scores": [
{
"channel": "web_push",
"sends": 1.5,
"engaged": 1.5,
"score": 1.5,
"is_best": true,
"computed_at": "örnek"
}
],
"decisions": [
{
"agent": "örnek",
"arm_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"context": "örnek",
"assigned_at": "örnek",
"rewarded_at": "örnek"
}
],
"recommendations": [
{
"catalog_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"personalized": [
"örnek"
],
"recent": [
"örnek"
],
"purchased": [
"örnek"
],
"computed_at": "örnek"
}
],
"affinities": [
{
"attribute": "örnek",
"value": "user_42",
"score": 1.5,
"rank": 1.5,
"computed_at": "örnek"
}
],
"frequency_cap": {
"weekly_cap": 1.5,
"engagement": 1.5,
"computed_at": "örnek"
},
"companies": [
{
"name": "Sipariş bildirimleri",
"company_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"role": "örnek",
"joined_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/export" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"The user's event and delivery timeline (newest 40 entries)
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: UserTimeline
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].kind | enum | Yes | Values: "event", "delivery" |
data[].at | string | Yes | |
data[].title | string | Yes | |
data[].detail | string | Yes |
Example response:
{
"data": [
{
"kind": "event",
"at": "örnek",
"title": "Siparişiniz yola çıktı",
"detail": "ö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/timeline" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"The user's recent events
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" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: EventList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].subscription_id | string | null | Yes | |
data[].name | string | Yes | |
data[].properties | map<string, any> | Yes | |
data[].value | number | null | Yes | |
data[].source | enum | Yes | Values: "sdk", "api", "system", "import" |
data[].occurred_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"properties": {
"order_id": "1001"
},
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"value": 149.9,
"source": "sdk",
"occurred_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/events?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"The user's recent messages (deliveries, newest first)
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" | |
limit | query | integer | No | Default: 20; Range: 1–100 | 50 |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UserMessageList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].delivery_id | string | Yes | |
data[].message_id | string | Yes | |
data[].campaign_id | string | null | Yes | |
data[].source | string | Yes | |
data[].channel | string | Yes | |
data[].status | string | Yes | |
data[].title | string | null | Yes | |
data[].body | string | null | Yes | |
data[].error_code | string | null | Yes | |
data[].created_at | string | Yes | |
data[].sent_at | string | null | Yes | |
data[].delivered_at | string | null | Yes | |
data[].opened_at | string | null | Yes | |
data[].clicked_at | string | null | Yes |
Example response:
{
"data": [
{
"channel": "web_push",
"status": "örnek",
"delivery_id": "dlv_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"message_id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"campaign_id": "cmp_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "örnek",
"title": "Siparişiniz yola çıktı",
"body": "Takip bağlantısı içeride",
"error_code": "örnek",
"created_at": "örnek",
"sent_at": "örnek",
"delivered_at": "örnek",
"opened_at": "örnek",
"clicked_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/messages?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Remove an alias
/v1/apps/{appId}/users/by/{label}/{value}/identity/{aliasLabel}Try it (interactive API docs, new tab)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" | |
aliasLabel | path | string | Yes | "crm_id" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UserDetail
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
external_id | string | null | Yes | |
properties | map<string, any> | Yes | |
tags | map<string, string> | Yes | |
first_seen_at | string | Yes | |
last_active_at | string | Yes | |
session_count | integer | Yes | |
usage_seconds | integer | Yes | |
merged_into | string | null | Yes | |
last_ip | string | null | Yes | |
last_ip_at | string | null | Yes | |
last_sentiment | enum | null | Yes | |
last_sentiment_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes | |
subscription_count | integer | Yes | |
channels | array<enum> | Yes | |
aliases | array<object> | Yes | |
aliases[].label | string | Yes | |
aliases[].value | string | Yes | |
subscriptions | array<object> | Yes | |
subscriptions[].id | string | Yes | |
subscriptions[].app_id | string | Yes | |
subscriptions[].user_id | string | null | Yes | |
subscriptions[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
subscriptions[].token | string | Yes | |
subscriptions[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
subscriptions[].unsubscribe_reason | enum | null | Yes | |
subscriptions[].device | object | Yes | |
subscriptions[].device.model | string | No | Length: 0–100 |
subscriptions[].device.os | string | No | Length: 0–50 |
subscriptions[].device.os_version | string | No | Length: 0–50 |
subscriptions[].device.app_version | string | null | No | |
subscriptions[].device.sdk_version | string | No | Length: 0–50 |
subscriptions[].device.sdk_platform | string | No | Length: 0–50 |
subscriptions[].device.carrier | string | No | Length: 0–100 |
subscriptions[].device.locale | string | No | Length: 0–20 |
subscriptions[].device.timezone | string | No | Length: 0–64 |
subscriptions[].device.push_capable | boolean | No | |
subscriptions[].device.push_environment | enum | No | Values: "sandbox", "production" |
subscriptions[].device.form_factor | enum | No | Values: "phone", "watch" |
subscriptions[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
subscriptions[].device.manufacturer | string | No | Length: 0–50 |
subscriptions[].device.brand | string | No | Length: 0–50 |
subscriptions[].device.rom | string | No | Length: 0–30 |
subscriptions[].device.rom_version | string | No | Length: 0–30 |
subscriptions[].device.delivery | object | No | |
subscriptions[].test_device | boolean | Yes | |
subscriptions[].test_device_name | string | null | Yes | |
subscriptions[].last_active_at | string | Yes | |
subscriptions[].last_sent_at | string | null | Yes | |
subscriptions[].last_delivered_at | string | null | Yes | |
subscriptions[].opted_in_at | string | null | Yes | |
subscriptions[].opt_in_source | string | null | Yes | |
subscriptions[].unsubscribed_at | string | null | Yes | |
subscriptions[].location | object | null | Yes | |
subscriptions[].created_at | string | Yes |
Example response:
{
"channels": [
"ios_push"
],
"tags": {
"plan": "pro",
"city": "Istanbul"
},
"properties": {
"order_id": "1001"
},
"subscriptions": [
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_at": "örnek"
}
],
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"external_id": "user_42",
"first_seen_at": "örnek",
"last_active_at": "örnek",
"session_count": 1,
"usage_seconds": 1,
"merged_into": "örnek",
"last_ip": "örnek",
"last_ip_at": "örnek",
"last_sentiment": "positive",
"last_sentiment_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek",
"subscription_count": 1,
"aliases": [
{
"label": "external_id",
"value": "user_42"
}
]
}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/users/by/external_id/user_42/identity/crm_id" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Add a subscription to the user
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: AddSubscriptionDto
| Field | Type | Required | Description |
|---|---|---|---|
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | Length: 1–4096 |
device | object | No | Default: {} |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
status | enum | No | Values: "subscribed", "unsubscribed" |
opt_in | object | No | |
opt_in.source | string | Yes | Length: 1–100 |
opt_in.at | string (date-time) | No |
Example:
{
"channel": "ios_push",
"token": "d1f2e3…",
"status": "subscribed",
"device": {},
"opt_in": {
"source": "örnek",
"at": "2026-10-17T09:00:00Z"
}
}Responses
201 — Success.
Schema: Subscription
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
user_id | string | null | Yes | |
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
unsubscribe_reason | enum | null | Yes | |
device | object | Yes | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | Yes | |
test_device_name | string | null | Yes | |
last_active_at | string | Yes | |
last_sent_at | string | null | Yes | |
last_delivered_at | string | null | Yes | |
opted_in_at | string | null | Yes | |
opt_in_source | string | null | Yes | |
unsubscribed_at | string | null | Yes | |
location | object | null | Yes | |
created_at | string | Yes |
Example response:
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek",
"app_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_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/users/by/external_id/user_42/subscriptions" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"channel": "ios_push",
"token": "d1f2e3…",
"status": "subscribed",
"device": {},
"opt_in": {
"source": "örnek",
"at": "2026-10-17T09:00:00Z"
}
}'List subscriptions (channel/status/test device filters; only the last 8 characters of the token are returned)
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: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" | "ios_push" |
status | query | enum | No | Values: "subscribed", "unsubscribed", "invalid", "pending" | "subscribed" |
test_device | query | enum | No | Values: "true", "false" | "true" |
since | query | string (date-time) | No | "2026-10-17T09:00:00Z" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: SubscriptionList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].user_id | string | null | Yes | |
data[].channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
data[].token | string | Yes | |
data[].status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
data[].unsubscribe_reason | enum | null | Yes | |
data[].device | object | Yes | |
data[].device.model | string | No | Length: 0–100 |
data[].device.os | string | No | Length: 0–50 |
data[].device.os_version | string | No | Length: 0–50 |
data[].device.app_version | string | null | No | |
data[].device.sdk_version | string | No | Length: 0–50 |
data[].device.sdk_platform | string | No | Length: 0–50 |
data[].device.carrier | string | No | Length: 0–100 |
data[].device.locale | string | No | Length: 0–20 |
data[].device.timezone | string | No | Length: 0–64 |
data[].device.push_capable | boolean | No | |
data[].device.push_environment | enum | No | Values: "sandbox", "production" |
data[].device.form_factor | enum | No | Values: "phone", "watch" |
data[].device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
data[].device.manufacturer | string | No | Length: 0–50 |
data[].device.brand | string | No | Length: 0–50 |
data[].device.rom | string | No | Length: 0–30 |
data[].device.rom_version | string | No | Length: 0–30 |
data[].device.delivery | object | No | |
data[].test_device | boolean | Yes | |
data[].test_device_name | string | null | Yes | |
data[].last_active_at | string | Yes | |
data[].last_sent_at | string | null | Yes | |
data[].last_delivered_at | string | null | Yes | |
data[].opted_in_at | string | null | Yes | |
data[].opt_in_source | string | null | Yes | |
data[].unsubscribed_at | string | null | Yes | |
data[].location | object | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"channel": "ios_push",
"status": "subscribed",
"id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_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/subscriptions?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Bulk cleanup: delete invalid (or unsubscribed) subscriptions
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: PublicCleanupSubscriptionsDto
| Field | Type | Required | Description |
|---|---|---|---|
status | enum | No | Values: "invalid", "unsubscribed" |
Example:
{
"status": "invalid"
}Responses
200 — Success.
Schema: CleanupResult
| Field | Type | Required | Description |
|---|---|---|---|
deleted | integer | Yes |
Example response:
{
"deleted": 1
}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/subscriptions/cleanup" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "invalid"
}'Subscription details
Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Subscription
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
user_id | string | null | Yes | |
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
unsubscribe_reason | enum | null | Yes | |
device | object | Yes | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | Yes | |
test_device_name | string | null | Yes | |
last_active_at | string | Yes | |
last_sent_at | string | null | Yes | |
last_delivered_at | string | null | Yes | |
opted_in_at | string | null | Yes | |
opt_in_source | string | null | Yes | |
unsubscribed_at | string | null | Yes | |
location | object | null | Yes | |
created_at | string | Yes |
Example response:
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek",
"app_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_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/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a subscription
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: PatchSubscriptionDto
| Field | Type | Required | Description |
|---|---|---|---|
token | string | No | Length: 1–4096 |
device | object | No | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
status | enum | No | Values: "subscribed", "unsubscribed" |
test_device | boolean | No | |
test_device_name | string | No | Length: 0–100 |
Example:
{
"status": "subscribed",
"token": "d1f2e3…",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek"
}Responses
200 — Success.
Schema: Subscription
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
user_id | string | null | Yes | |
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
unsubscribe_reason | enum | null | Yes | |
device | object | Yes | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | Yes | |
test_device_name | string | null | Yes | |
last_active_at | string | Yes | |
last_sent_at | string | null | Yes | |
last_delivered_at | string | null | Yes | |
opted_in_at | string | null | Yes | |
opt_in_source | string | null | Yes | |
unsubscribed_at | string | null | Yes | |
location | object | null | Yes | |
created_at | string | Yes |
Example response:
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek",
"app_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_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/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "subscribed",
"token": "d1f2e3…",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek"
}'Delete a subscription
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
subscriptionId | path | string | Yes | "sub_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/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Identities of the user who owns the subscription
/v1/apps/{appId}/subscriptions/{subscriptionId}/user/identityTry it (interactive API docs, new tab)Authentication: API key — scope users:read (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: UserIdentity
| Field | Type | Required | Description |
|---|---|---|---|
identity | map<string, string> | Yes |
Example response:
{
"identity": {
"external_id": [
"user_42"
]
}
}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/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/user/identity" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update a subscription by token (token_type: ios_push, android_push, hms_push, web_push, email, sms or the legacy provider names iOSPush, AndroidPush, HuaweiPush, ChromePush, FirefoxPush, SafariPush, Email, SMS)
/v1/apps/{appId}/subscriptions_by_token/{tokenType}/{token}Try it (interactive API docs, new tab)Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
tokenType | path | string | Yes | "örnek" | |
token | path | string | Yes | "d1f2e3…" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: PatchSubscriptionDto
| Field | Type | Required | Description |
|---|---|---|---|
token | string | No | Length: 1–4096 |
device | object | No | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
status | enum | No | Values: "subscribed", "unsubscribed" |
test_device | boolean | No | |
test_device_name | string | No | Length: 0–100 |
Example:
{
"status": "subscribed",
"token": "d1f2e3…",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek"
}Responses
200 — Success.
Schema: Subscription
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
user_id | string | null | Yes | |
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
unsubscribe_reason | enum | null | Yes | |
device | object | Yes | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | Yes | |
test_device_name | string | null | Yes | |
last_active_at | string | Yes | |
last_sent_at | string | null | Yes | |
last_delivered_at | string | null | Yes | |
opted_in_at | string | null | Yes | |
opt_in_source | string | null | Yes | |
unsubscribed_at | string | null | Yes | |
location | object | null | Yes | |
created_at | string | Yes |
Example response:
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek",
"app_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_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/subscriptions_by_token/örnek/d1f2e3…" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"status": "subscribed",
"token": "d1f2e3…",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek"
}'Link the subscription to a user by external_id
Authentication: API key — scope users:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
subscriptionId | path | string | Yes | "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: SetOwnerDto
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string | Yes | Length: 1–255 |
Example:
{
"external_id": "user_42"
}Responses
200 — Success.
Schema: Subscription
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
user_id | string | null | Yes | |
channel | enum | Yes | Values: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber" |
token | string | Yes | |
status | enum | Yes | Values: "subscribed", "unsubscribed", "invalid", "pending" |
unsubscribe_reason | enum | null | Yes | |
device | object | Yes | |
device.model | string | No | Length: 0–100 |
device.os | string | No | Length: 0–50 |
device.os_version | string | No | Length: 0–50 |
device.app_version | string | null | No | |
device.sdk_version | string | No | Length: 0–50 |
device.sdk_platform | string | No | Length: 0–50 |
device.carrier | string | No | Length: 0–100 |
device.locale | string | No | Length: 0–20 |
device.timezone | string | No | Length: 0–64 |
device.push_capable | boolean | No | |
device.push_environment | enum | No | Values: "sandbox", "production" |
device.form_factor | enum | No | Values: "phone", "watch" |
device.push_kind | enum | No | Values: "alert", "voip", "app_clip" |
device.manufacturer | string | No | Length: 0–50 |
device.brand | string | No | Length: 0–50 |
device.rom | string | No | Length: 0–30 |
device.rom_version | string | No | Length: 0–30 |
device.delivery | object | No | |
device.delivery.battery_optimization_exempt | boolean | No | |
device.delivery.background_restricted | boolean | No | |
device.delivery.channel_blocked | boolean | No | |
device.delivery.power_save_mode | boolean | No | |
device.delivery.data_saver | boolean | No | |
device.delivery.standby_bucket | enum | No | Values: "exempted", "active", "working_set", "frequent", "rare", "restricted" |
test_device | boolean | Yes | |
test_device_name | string | null | Yes | |
last_active_at | string | Yes | |
last_sent_at | string | null | Yes | |
last_delivered_at | string | null | Yes | |
opted_in_at | string | null | Yes | |
opt_in_source | string | null | Yes | |
unsubscribed_at | string | null | Yes | |
location | object | null | Yes | |
created_at | string | Yes |
Example response:
{
"channel": "ios_push",
"status": "subscribed",
"id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"token": "d1f2e3…",
"unsubscribe_reason": "provider_rejected",
"device": {
"model": "örnek",
"os": "örnek",
"os_version": "örnek",
"app_version": "örnek"
},
"test_device": true,
"test_device_name": "örnek",
"last_active_at": "örnek",
"last_sent_at": "örnek",
"last_delivered_at": "örnek",
"opted_in_at": "örnek",
"opt_in_source": "örnek",
"unsubscribed_at": "örnek",
"location": {
"lat": 1.5,
"lng": 1.5,
"accuracy_m": 1.5,
"geohash": "örnek",
"updated_at": "örnek",
"consent_at": "örnek"
},
"created_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/subscriptions/sub_01JD3W5Q7X9K2M4N6P8R0T1V3W/owner" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"external_id": "user_42"
}'Send events in bulk (up to 500)
Authentication: API key — scope events:write (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ApiEventsDto
| Field | Type | Required | Description |
|---|---|---|---|
events | array<object> | Yes | Items: 1–500 |
events[].name | string | Yes | Length: 1–100 |
events[].properties | map<string, any> | No | Default: {} |
events[].value | number | No | |
events[].occurred_at | string (date-time) | No | |
events[].event_id | string | No | Length: 8–64 |
events[].subscription_id | string | No | Length: 1–∞ |
events[].external_id | string | No | Length: 1–255 |
Example:
{
"events": [
{
"name": "purchase",
"properties": {},
"value": 149.9,
"occurred_at": "2026-10-17T09:00:00Z"
}
]
}Responses
200 — Success.
Schema: EventsAccepted
| Field | Type | Required | Description |
|---|---|---|---|
accepted | integer | Yes |
Example response:
{
"accepted": 1
}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/events" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"events": [
{
"name": "purchase",
"properties": {},
"value": 149.9,
"occurred_at": "2026-10-17T09:00:00Z"
}
]
}'Notifications
Notifications — 9 operations (GET /v1/notifications, POST /v1/notifications, POST /v1/notifications/estimate, …). Generated from the OpenAPI 3.1.0 contract.
Event definitions
Event definitions — 4 operations (GET /v1/apps/{appId}/events/definitions, GET /v1/apps/{appId}/events/definitions/{name}, PATCH /v1/apps/{appId}/events/definitions/{name}, …). Generated from the OpenAPI 3.1.0 contract.