PushizoDocs
API reference

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

MethodPathOperation
GET/v1/apps/{appId}/companiesList companies
POST/v1/apps/{appId}/companiesCreate or update a company (by external_id)
POST/v1/apps/{appId}/companies/batchBulk 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}/membersList company members
POST/v1/apps/{appId}/companies/{companyId}/members/batchAdd 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}/companiesList a user's companies
GET/v1/apps/{appId}/users/by/{label}/{value}/companiesList a user's companies (by external_id or alias)
GET/v1/apps/{appId}/usersList users
POST/v1/apps/{appId}/usersCreate/update a user (by external_id, optionally with subscriptions)
POST/v1/apps/{appId}/users/searchSearch 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}/identityAll identities of the user (hs_id, external_id, custom aliases)
PATCH/v1/apps/{appId}/users/by/{label}/{value}/identityAdd an alias
GET/v1/apps/{appId}/users/by/{label}/{value}/exportExport user data (KVKK/GDPR portability): profile, aliases, subscriptions, recent events
GET/v1/apps/{appId}/users/by/{label}/{value}/timelineThe user's event and delivery timeline (newest 40 entries)
GET/v1/apps/{appId}/users/by/{label}/{value}/eventsThe user's recent events
GET/v1/apps/{appId}/users/by/{label}/{value}/messagesThe 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}/subscriptionsAdd a subscription to the user
GET/v1/apps/{appId}/subscriptionsList subscriptions (channel/status/test device filters; only the last 8 characters of the token are returned)
POST/v1/apps/{appId}/subscriptions/cleanupBulk 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/identityIdentities 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}/ownerLink the subscription to a user by external_id
POST/v1/apps/{appId}/eventsSend events in bulk (up to 500)

Details

List companies

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

Searches name, external ID or domain; newest first.

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
qquerystringNoLength: 1–200"ayse"
external_idquerystringNo"user_42"
domainquerystringNoLength: 1–253"örnek"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CompanyList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].external_idstringYes
data[].namestring | nullYes
data[].domainstring | nullYes
data[].propertiesmap<string, any>Yes
data[].member_countintegerYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

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)

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

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

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpsertCompanyDto

FieldTypeRequiredDescription
external_idstringYes
namestring | nullNo
domainstring | nullNo
propertiesmap<string, any>No

Example:

{
  "external_id": "user_42",
  "name": "Sipariş bildirimleri",
  "properties": {
    "order_id": "1001"
  },
  "domain": "örnek"
}

Responses

201 — Success.

Schema: Company

FieldTypeRequiredDescription
idstringYes
external_idstringYes
namestring | nullYes
domainstring | nullYes
propertiesmap<string, any>Yes
member_countintegerYes
created_atstringYes
updated_atstringYes

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

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

Up to 1000 companies per request; each is upserted by external_id.

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: BatchUpsertCompaniesDto

FieldTypeRequiredDescription
companiesarray<object>YesItems: 1–1000
companies[].external_idstringYes
companies[].namestring | nullNo
companies[].domainstring | nullNo
companies[].propertiesmap<string, any>No

Example:

{
  "companies": [
    {
      "external_id": "user_42",
      "name": "Sipariş bildirimleri",
      "properties": {
        "order_id": "1001"
      },
      "domain": "örnek"
    }
  ]
}

Responses

200 — Success.

Schema: CompanyBatchResult

FieldTypeRequiredDescription
createdintegerYes
updatedintegerYes
dataarray<object>Yes
data[].idstringYes
data[].external_idstringYes
data[].createdbooleanYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
companyIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Company

FieldTypeRequiredDescription
idstringYes
external_idstringYes
namestring | nullYes
domainstring | nullYes
propertiesmap<string, any>Yes
member_countintegerYes
created_atstringYes
updated_atstringYes

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

PATCH/v1/apps/{appId}/companies/{companyId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
companyIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateCompanyDto

FieldTypeRequiredDescription
external_idstringNo
namestring | nullNo
domainstring | nullNo
propertiesmap<string, any>No

Example:

{
  "name": "Sipariş bildirimleri",
  "properties": {
    "order_id": "1001"
  },
  "external_id": "user_42",
  "domain": "örnek"
}

Responses

200 — Success.

Schema: Company

FieldTypeRequiredDescription
idstringYes
external_idstringYes
namestring | nullYes
domainstring | nullYes
propertiesmap<string, any>Yes
member_countintegerYes
created_atstringYes
updated_atstringYes

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

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

Memberships are removed; users are kept.

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

Parameters

NameInTypeRequiredDescriptionExample
companyIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

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

List company members

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

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

Parameters

NameInTypeRequiredDescriptionExample
companyIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
rolequerystringNo"değer"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: CompanyMemberList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].company_idstringYes
data[].user_idstringYes
data[].external_idstring | nullYes
data[].rolestringYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

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

POST/v1/apps/{appId}/companies/{companyId}/members/batchTry it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
companyIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: BatchMembersDto

FieldTypeRequiredDescription
membersarray<object>YesItems: 1–1000
members[].user_idstringNoLength: 1–64
members[].external_idstringNoLength: 1–255
members[].rolestringNo

Example:

{
  "members": [
    {
      "user_id": "usr_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "external_id": "user_42",
      "role": "değer"
    }
  ]
}

Responses

200 — Success.

Schema: CompanyMemberBatchResult

FieldTypeRequiredDescription
addedintegerYes
updatedintegerYes
not_foundarray<object>Yes
not_found[].indexintegerYes
not_found[].user_idstring | nullYes
not_found[].external_idstring | nullYes

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

PUT/v1/apps/{appId}/companies/{companyId}/members/{userId}Try it (interactive API docs, new tab)

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

NameInTypeRequiredDescriptionExample
companyIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SetMemberDto

FieldTypeRequiredDescription
rolestringNo

Example:

{
  "role": "değer"
}

Responses

200 — Success.

Schema: CompanyMember

FieldTypeRequiredDescription
company_idstringYes
user_idstringYes
external_idstring | nullYes
rolestringYes
created_atstringYes
updated_atstringYes

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

DELETE/v1/apps/{appId}/companies/{companyId}/members/{userId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
companyIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

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

List a user's companies

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

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

NameInTypeRequiredDescriptionExample
userIdpathstringYes"usr_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserCompanyList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].companyobjectYes
data[].company.idstringYes
data[].company.external_idstringYes
data[].company.namestring | nullYes
data[].company.domainstring | nullYes
data[].company.propertiesmap<string, any>Yes
data[].rolestringYes
data[].created_atstringYes
data[].updated_atstringYes

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)

GET/v1/apps/{appId}/users/by/{label}/{value}/companiesTry it (interactive API docs, new tab)

label: hs_id, external_id or a custom alias label.

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserCompanyList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].companyobjectYes
data[].company.idstringYes
data[].company.external_idstringYes
data[].company.namestring | nullYes
data[].company.domainstring | nullYes
data[].company.propertiesmap<string, any>Yes
data[].rolestringYes
data[].created_atstringYes
data[].updated_atstringYes

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

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
sortqueryenumNoValues: "last_active_at", "-last_active_at""last_active_at"
qquerystringNoLength: 1–255"ayse"
ipquerystringNoLength: 2–64"örnek"
tagquerystringNoLength: 3–320"plan:pro"
last_active_afterquerystring (date-time)No"2026-10-17T09:00:00Z"
last_active_beforequerystring (date-time)No"2026-10-17T09:00:00Z"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].external_idstring | nullYes
data[].propertiesmap<string, any>Yes
data[].tagsmap<string, string>Yes
data[].first_seen_atstringYes
data[].last_active_atstringYes
data[].session_countintegerYes
data[].usage_secondsintegerYes
data[].merged_intostring | nullYes
data[].last_ipstring | nullYes
data[].last_ip_atstring | nullYes
data[].last_sentimentenum | nullYes
data[].last_sentiment_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].subscription_countintegerYes
data[].channelsarray<enum>Yes
next_cursorstring | nullYes
has_morebooleanYes

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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
Idempotency-KeyheaderstringNoA request repeated with the same key within 24 hours returns the same response."order-1001"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpsertUserDto

FieldTypeRequiredDescription
identityobjectNo
identity.external_idstringYesLength: 1–255
external_idstringNoLength: 1–255
propertiesmap<string, any>No
tagsmap<string, string>No
subscriptionsarray<object>NoItems: 0–20
subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
subscriptions[].tokenstringYesLength: 1–4096
subscriptions[].deviceobjectNoDefault: {}
subscriptions[].device.modelstringNoLength: 0–100
subscriptions[].device.osstringNoLength: 0–50
subscriptions[].device.os_versionstringNoLength: 0–50
subscriptions[].device.app_versionstring | nullNo
subscriptions[].device.sdk_versionstringNoLength: 0–50
subscriptions[].device.sdk_platformstringNoLength: 0–50
subscriptions[].device.carrierstringNoLength: 0–100
subscriptions[].device.localestringNoLength: 0–20
subscriptions[].device.timezonestringNoLength: 0–64
subscriptions[].device.push_capablebooleanNo
subscriptions[].device.push_environmentenumNoValues: "sandbox", "production"
subscriptions[].device.form_factorenumNoValues: "phone", "watch"
subscriptions[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
subscriptions[].device.manufacturerstringNoLength: 0–50
subscriptions[].device.brandstringNoLength: 0–50
subscriptions[].device.romstringNoLength: 0–30
subscriptions[].device.rom_versionstringNoLength: 0–30
subscriptions[].device.deliveryobjectNo
subscriptions[].device.delivery.battery_optimization_exemptbooleanNo
subscriptions[].device.delivery.background_restrictedbooleanNo
subscriptions[].device.delivery.channel_blockedbooleanNo
subscriptions[].device.delivery.power_save_modebooleanNo
subscriptions[].device.delivery.data_saverbooleanNo
subscriptions[].device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
subscriptions[].statusenumNoValues: "subscribed", "unsubscribed"
subscriptions[].opt_inobjectNo
subscriptions[].opt_in.sourcestringYesLength: 1–100
subscriptions[].opt_in.atstring (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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
external_idstring | nullYes
propertiesmap<string, any>Yes
tagsmap<string, string>Yes
first_seen_atstringYes
last_active_atstringYes
session_countintegerYes
usage_secondsintegerYes
merged_intostring | nullYes
last_ipstring | nullYes
last_ip_atstring | nullYes
last_sentimentenum | nullYes
last_sentiment_atstring | nullYes
created_atstringYes
updated_atstringYes
subscription_countintegerYes
channelsarray<enum>Yes
aliasesarray<object>Yes
aliases[].labelstringYes
aliases[].valuestringYes
subscriptionsarray<object>Yes
subscriptions[].idstringYes
subscriptions[].app_idstringYes
subscriptions[].user_idstring | nullYes
subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
subscriptions[].tokenstringYes
subscriptions[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
subscriptions[].unsubscribe_reasonenum | nullYes
subscriptions[].deviceobjectYes
subscriptions[].device.modelstringNoLength: 0–100
subscriptions[].device.osstringNoLength: 0–50
subscriptions[].device.os_versionstringNoLength: 0–50
subscriptions[].device.app_versionstring | nullNo
subscriptions[].device.sdk_versionstringNoLength: 0–50
subscriptions[].device.sdk_platformstringNoLength: 0–50
subscriptions[].device.carrierstringNoLength: 0–100
subscriptions[].device.localestringNoLength: 0–20
subscriptions[].device.timezonestringNoLength: 0–64
subscriptions[].device.push_capablebooleanNo
subscriptions[].device.push_environmentenumNoValues: "sandbox", "production"
subscriptions[].device.form_factorenumNoValues: "phone", "watch"
subscriptions[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
subscriptions[].device.manufacturerstringNoLength: 0–50
subscriptions[].device.brandstringNoLength: 0–50
subscriptions[].device.romstringNoLength: 0–30
subscriptions[].device.rom_versionstringNoLength: 0–30
subscriptions[].device.deliveryobjectNo
subscriptions[].test_devicebooleanYes
subscriptions[].test_device_namestring | nullYes
subscriptions[].last_active_atstringYes
subscriptions[].last_sent_atstring | nullYes
subscriptions[].last_delivered_atstring | nullYes
subscriptions[].opted_in_atstring | nullYes
subscriptions[].opt_in_sourcestring | nullYes
subscriptions[].unsubscribed_atstring | nullYes
subscriptions[].locationobject | nullYes
subscriptions[].created_atstringYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

FieldTypeRequiredDescription
definitionobjectYesFilter AST: all/any/none groups and { field, op, value } conditions (docs/plan/05 §5.7).
definition.allarray<object>No
definition.anyarray<object>No
definition.nonearray<object>No
limitintegerNoDefault: 50; Range: 1–200
cursorstringNo

Example:

{
  "definition": {
    "all": [
      {}
    ],
    "any": [
      {}
    ],
    "none": [
      {}
    ]
  },
  "limit": 50,
  "cursor": "eyJpZCI6Im1zZ18wMUpE…"
}

Responses

200 — Success.

Schema: UserList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].external_idstring | nullYes
data[].propertiesmap<string, any>Yes
data[].tagsmap<string, string>Yes
data[].first_seen_atstringYes
data[].last_active_atstringYes
data[].session_countintegerYes
data[].usage_secondsintegerYes
data[].merged_intostring | nullYes
data[].last_ipstring | nullYes
data[].last_ip_atstring | nullYes
data[].last_sentimentenum | nullYes
data[].last_sentiment_atstring | nullYes
data[].created_atstringYes
data[].updated_atstringYes
data[].subscription_countintegerYes
data[].channelsarray<enum>Yes
next_cursorstring | nullYes
has_morebooleanYes

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)

GET/v1/apps/{appId}/users/by/{label}/{value}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
external_idstring | nullYes
propertiesmap<string, any>Yes
tagsmap<string, string>Yes
first_seen_atstringYes
last_active_atstringYes
session_countintegerYes
usage_secondsintegerYes
merged_intostring | nullYes
last_ipstring | nullYes
last_ip_atstring | nullYes
last_sentimentenum | nullYes
last_sentiment_atstring | nullYes
created_atstringYes
updated_atstringYes
subscription_countintegerYes
channelsarray<enum>Yes
aliasesarray<object>Yes
aliases[].labelstringYes
aliases[].valuestringYes
subscriptionsarray<object>Yes
subscriptions[].idstringYes
subscriptions[].app_idstringYes
subscriptions[].user_idstring | nullYes
subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
subscriptions[].tokenstringYes
subscriptions[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
subscriptions[].unsubscribe_reasonenum | nullYes
subscriptions[].deviceobjectYes
subscriptions[].device.modelstringNoLength: 0–100
subscriptions[].device.osstringNoLength: 0–50
subscriptions[].device.os_versionstringNoLength: 0–50
subscriptions[].device.app_versionstring | nullNo
subscriptions[].device.sdk_versionstringNoLength: 0–50
subscriptions[].device.sdk_platformstringNoLength: 0–50
subscriptions[].device.carrierstringNoLength: 0–100
subscriptions[].device.localestringNoLength: 0–20
subscriptions[].device.timezonestringNoLength: 0–64
subscriptions[].device.push_capablebooleanNo
subscriptions[].device.push_environmentenumNoValues: "sandbox", "production"
subscriptions[].device.form_factorenumNoValues: "phone", "watch"
subscriptions[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
subscriptions[].device.manufacturerstringNoLength: 0–50
subscriptions[].device.brandstringNoLength: 0–50
subscriptions[].device.romstringNoLength: 0–30
subscriptions[].device.rom_versionstringNoLength: 0–30
subscriptions[].device.deliveryobjectNo
subscriptions[].test_devicebooleanYes
subscriptions[].test_device_namestring | nullYes
subscriptions[].last_active_atstringYes
subscriptions[].last_sent_atstring | nullYes
subscriptions[].last_delivered_atstring | nullYes
subscriptions[].opted_in_atstring | nullYes
subscriptions[].opt_in_sourcestring | nullYes
subscriptions[].unsubscribed_atstring | nullYes
subscriptions[].locationobject | nullYes
subscriptions[].created_atstringYes

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

PATCH/v1/apps/{appId}/users/by/{label}/{value}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PatchUserDto

FieldTypeRequiredDescription
propertiesmap<string, any>No
tagsmap<string, string | null>No
deltasobjectNo
deltas.session_countintegerNoRange: -1000000–1000000
deltas.session_timeintegerNoRange: 0–31536000
deltas.purchasesarray<object>NoItems: 0–100
deltas.purchases[].skustringYesLength: 1–100
deltas.purchases[].amountnumberYesRange: 0–∞
deltas.purchases[].isostringNoLength: 3–3
deltas.purchases[].countintegerNoDefault: 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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
external_idstring | nullYes
propertiesmap<string, any>Yes
tagsmap<string, string>Yes
first_seen_atstringYes
last_active_atstringYes
session_countintegerYes
usage_secondsintegerYes
merged_intostring | nullYes
last_ipstring | nullYes
last_ip_atstring | nullYes
last_sentimentenum | nullYes
last_sentiment_atstring | nullYes
created_atstringYes
updated_atstringYes
subscription_countintegerYes
channelsarray<enum>Yes
aliasesarray<object>Yes
aliases[].labelstringYes
aliases[].valuestringYes
subscriptionsarray<object>Yes
subscriptions[].idstringYes
subscriptions[].app_idstringYes
subscriptions[].user_idstring | nullYes
subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
subscriptions[].tokenstringYes
subscriptions[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
subscriptions[].unsubscribe_reasonenum | nullYes
subscriptions[].deviceobjectYes
subscriptions[].device.modelstringNoLength: 0–100
subscriptions[].device.osstringNoLength: 0–50
subscriptions[].device.os_versionstringNoLength: 0–50
subscriptions[].device.app_versionstring | nullNo
subscriptions[].device.sdk_versionstringNoLength: 0–50
subscriptions[].device.sdk_platformstringNoLength: 0–50
subscriptions[].device.carrierstringNoLength: 0–100
subscriptions[].device.localestringNoLength: 0–20
subscriptions[].device.timezonestringNoLength: 0–64
subscriptions[].device.push_capablebooleanNo
subscriptions[].device.push_environmentenumNoValues: "sandbox", "production"
subscriptions[].device.form_factorenumNoValues: "phone", "watch"
subscriptions[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
subscriptions[].device.manufacturerstringNoLength: 0–50
subscriptions[].device.brandstringNoLength: 0–50
subscriptions[].device.romstringNoLength: 0–30
subscriptions[].device.rom_versionstringNoLength: 0–30
subscriptions[].device.deliveryobjectNo
subscriptions[].test_devicebooleanYes
subscriptions[].test_device_namestring | nullYes
subscriptions[].last_active_atstringYes
subscriptions[].last_sent_atstring | nullYes
subscriptions[].last_delivered_atstring | nullYes
subscriptions[].opted_in_atstring | nullYes
subscriptions[].opt_in_sourcestring | nullYes
subscriptions[].unsubscribed_atstring | nullYes
subscriptions[].locationobject | nullYes
subscriptions[].created_atstringYes

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)

DELETE/v1/apps/{appId}/users/by/{label}/{value}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/users/by/external_id/user_42" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

All identities of the user (hs_id, external_id, custom aliases)

GET/v1/apps/{appId}/users/by/{label}/{value}/identityTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserIdentity

FieldTypeRequiredDescription
identitymap<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

PATCH/v1/apps/{appId}/users/by/{label}/{value}/identityTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: AddAliasDto

FieldTypeRequiredDescription
identitymap<string, string>Yes

Example:

{
  "identity": {
    "external_id": [
      "user_42"
    ]
  }
}

Responses

200 — Success.

Schema: UserDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
external_idstring | nullYes
propertiesmap<string, any>Yes
tagsmap<string, string>Yes
first_seen_atstringYes
last_active_atstringYes
session_countintegerYes
usage_secondsintegerYes
merged_intostring | nullYes
last_ipstring | nullYes
last_ip_atstring | nullYes
last_sentimentenum | nullYes
last_sentiment_atstring | nullYes
created_atstringYes
updated_atstringYes
subscription_countintegerYes
channelsarray<enum>Yes
aliasesarray<object>Yes
aliases[].labelstringYes
aliases[].valuestringYes
subscriptionsarray<object>Yes
subscriptions[].idstringYes
subscriptions[].app_idstringYes
subscriptions[].user_idstring | nullYes
subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
subscriptions[].tokenstringYes
subscriptions[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
subscriptions[].unsubscribe_reasonenum | nullYes
subscriptions[].deviceobjectYes
subscriptions[].device.modelstringNoLength: 0–100
subscriptions[].device.osstringNoLength: 0–50
subscriptions[].device.os_versionstringNoLength: 0–50
subscriptions[].device.app_versionstring | nullNo
subscriptions[].device.sdk_versionstringNoLength: 0–50
subscriptions[].device.sdk_platformstringNoLength: 0–50
subscriptions[].device.carrierstringNoLength: 0–100
subscriptions[].device.localestringNoLength: 0–20
subscriptions[].device.timezonestringNoLength: 0–64
subscriptions[].device.push_capablebooleanNo
subscriptions[].device.push_environmentenumNoValues: "sandbox", "production"
subscriptions[].device.form_factorenumNoValues: "phone", "watch"
subscriptions[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
subscriptions[].device.manufacturerstringNoLength: 0–50
subscriptions[].device.brandstringNoLength: 0–50
subscriptions[].device.romstringNoLength: 0–30
subscriptions[].device.rom_versionstringNoLength: 0–30
subscriptions[].device.deliveryobjectNo
subscriptions[].test_devicebooleanYes
subscriptions[].test_device_namestring | nullYes
subscriptions[].last_active_atstringYes
subscriptions[].last_sent_atstring | nullYes
subscriptions[].last_delivered_atstring | nullYes
subscriptions[].opted_in_atstring | nullYes
subscriptions[].opt_in_sourcestring | nullYes
subscriptions[].unsubscribed_atstring | nullYes
subscriptions[].locationobject | nullYes
subscriptions[].created_atstringYes

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

GET/v1/apps/{appId}/users/by/{label}/{value}/exportTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserExport

FieldTypeRequiredDescription
exported_atstringYes
userobjectYes
user.idstringYes
user.app_idstringYes
user.external_idstring | nullYes
user.propertiesmap<string, any>Yes
user.tagsmap<string, string>Yes
user.first_seen_atstringYes
user.last_active_atstringYes
user.session_countintegerYes
user.usage_secondsintegerYes
user.merged_intostring | nullYes
user.last_ipstring | nullYes
user.last_ip_atstring | nullYes
user.last_sentimentenum | nullYes
user.last_sentiment_atstring | nullYes
user.created_atstringYes
user.updated_atstringYes
user.subscription_countintegerYes
user.channelsarray<enum>Yes
user.aliasesarray<object>Yes
user.aliases[].labelstringYes
user.aliases[].valuestringYes
user.subscriptionsarray<object>Yes
user.subscriptions[].idstringYes
user.subscriptions[].app_idstringYes
user.subscriptions[].user_idstring | nullYes
user.subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
user.subscriptions[].tokenstringYes
user.subscriptions[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
user.subscriptions[].unsubscribe_reasonenum | nullYes
user.subscriptions[].deviceobjectYes
user.subscriptions[].test_devicebooleanYes
user.subscriptions[].test_device_namestring | nullYes
user.subscriptions[].last_active_atstringYes
user.subscriptions[].last_sent_atstring | nullYes
user.subscriptions[].last_delivered_atstring | nullYes
user.subscriptions[].opted_in_atstring | nullYes
user.subscriptions[].opt_in_sourcestring | nullYes
user.subscriptions[].unsubscribed_atstring | nullYes
user.subscriptions[].locationobject | nullYes
user.subscriptions[].created_atstringYes
eventsarray<object>Yes
events[].idstringYes
events[].user_idstring | nullYes
events[].subscription_idstring | nullYes
events[].namestringYes
events[].propertiesmap<string, any>Yes
events[].valuenumber | nullYes
events[].sourceenumYesValues: "sdk", "api", "system", "import"
events[].occurred_atstringYes
derivedobjectYes
derived.wallet_passesarray<object>Yes
derived.wallet_passes[].idstringYes
derived.wallet_passes[].template_idstringYes
derived.wallet_passes[].statusstringYes
derived.wallet_passes[].barcode_valuestringYes
derived.wallet_passes[].valuesmap<string, string>Yes
derived.wallet_passes[].created_atstringYes
derived.wallet_passes[].updated_atstringYes
derived.rfmobject | nullYes
derived.predictionsarray<object>Yes
derived.predictions[].modelstringYes
derived.predictions[].scorenumberYes
derived.predictions[].computed_atstringYes
derived.channel_scoresarray<object>Yes
derived.channel_scores[].channelstringYes
derived.channel_scores[].sendsnumberYes
derived.channel_scores[].engagednumberYes
derived.channel_scores[].scorenumberYes
derived.channel_scores[].is_bestbooleanYes
derived.channel_scores[].computed_atstringYes
derived.decisionsarray<object>Yes
derived.decisions[].agentstringYes
derived.decisions[].arm_idstringYes
derived.decisions[].contextstringYes
derived.decisions[].assigned_atstringYes
derived.decisions[].rewarded_atstring | nullYes
derived.recommendationsarray<object>Yes
derived.recommendations[].catalog_idstringYes
derived.recommendations[].personalizedarray<string>Yes
derived.recommendations[].recentarray<string>Yes
derived.recommendations[].purchasedarray<string>Yes
derived.recommendations[].computed_atstringYes
derived.affinitiesarray<object>Yes
derived.affinities[].attributestringYes
derived.affinities[].valuestringYes
derived.affinities[].scorenumberYes
derived.affinities[].ranknumberYes
derived.affinities[].computed_atstringYes
derived.frequency_capobject | nullYes
derived.companiesarray<object>Yes
derived.companies[].company_idstringYes
derived.companies[].external_idstringYes
derived.companies[].namestring | nullYes
derived.companies[].rolestringYes
derived.companies[].joined_atstringYes

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)

GET/v1/apps/{appId}/users/by/{label}/{value}/timelineTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserTimeline

FieldTypeRequiredDescription
dataarray<object>Yes
data[].kindenumYesValues: "event", "delivery"
data[].atstringYes
data[].titlestringYes
data[].detailstringYes

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

GET/v1/apps/{appId}/users/by/{label}/{value}/eventsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
limitqueryintegerNoDefault: 50; Range: 1–20050
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: EventList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].user_idstring | nullYes
data[].subscription_idstring | nullYes
data[].namestringYes
data[].propertiesmap<string, any>Yes
data[].valuenumber | nullYes
data[].sourceenumYesValues: "sdk", "api", "system", "import"
data[].occurred_atstringYes

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)

GET/v1/apps/{appId}/users/by/{label}/{value}/messagesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
limitqueryintegerNoDefault: 20; Range: 1–10050
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserMessageList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].delivery_idstringYes
data[].message_idstringYes
data[].campaign_idstring | nullYes
data[].sourcestringYes
data[].channelstringYes
data[].statusstringYes
data[].titlestring | nullYes
data[].bodystring | nullYes
data[].error_codestring | nullYes
data[].created_atstringYes
data[].sent_atstring | nullYes
data[].delivered_atstring | nullYes
data[].opened_atstring | nullYes
data[].clicked_atstring | nullYes

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

DELETE/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

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
aliasLabelpathstringYes"crm_id"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserDetail

FieldTypeRequiredDescription
idstringYes
app_idstringYes
external_idstring | nullYes
propertiesmap<string, any>Yes
tagsmap<string, string>Yes
first_seen_atstringYes
last_active_atstringYes
session_countintegerYes
usage_secondsintegerYes
merged_intostring | nullYes
last_ipstring | nullYes
last_ip_atstring | nullYes
last_sentimentenum | nullYes
last_sentiment_atstring | nullYes
created_atstringYes
updated_atstringYes
subscription_countintegerYes
channelsarray<enum>Yes
aliasesarray<object>Yes
aliases[].labelstringYes
aliases[].valuestringYes
subscriptionsarray<object>Yes
subscriptions[].idstringYes
subscriptions[].app_idstringYes
subscriptions[].user_idstring | nullYes
subscriptions[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
subscriptions[].tokenstringYes
subscriptions[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
subscriptions[].unsubscribe_reasonenum | nullYes
subscriptions[].deviceobjectYes
subscriptions[].device.modelstringNoLength: 0–100
subscriptions[].device.osstringNoLength: 0–50
subscriptions[].device.os_versionstringNoLength: 0–50
subscriptions[].device.app_versionstring | nullNo
subscriptions[].device.sdk_versionstringNoLength: 0–50
subscriptions[].device.sdk_platformstringNoLength: 0–50
subscriptions[].device.carrierstringNoLength: 0–100
subscriptions[].device.localestringNoLength: 0–20
subscriptions[].device.timezonestringNoLength: 0–64
subscriptions[].device.push_capablebooleanNo
subscriptions[].device.push_environmentenumNoValues: "sandbox", "production"
subscriptions[].device.form_factorenumNoValues: "phone", "watch"
subscriptions[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
subscriptions[].device.manufacturerstringNoLength: 0–50
subscriptions[].device.brandstringNoLength: 0–50
subscriptions[].device.romstringNoLength: 0–30
subscriptions[].device.rom_versionstringNoLength: 0–30
subscriptions[].device.deliveryobjectNo
subscriptions[].test_devicebooleanYes
subscriptions[].test_device_namestring | nullYes
subscriptions[].last_active_atstringYes
subscriptions[].last_sent_atstring | nullYes
subscriptions[].last_delivered_atstring | nullYes
subscriptions[].opted_in_atstring | nullYes
subscriptions[].opt_in_sourcestring | nullYes
subscriptions[].unsubscribed_atstring | nullYes
subscriptions[].locationobject | nullYes
subscriptions[].created_atstringYes

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

POST/v1/apps/{appId}/users/by/{label}/{value}/subscriptionsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
labelpathstringYes"external_id"
valuepathstringYes"user_42"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: AddSubscriptionDto

FieldTypeRequiredDescription
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYesLength: 1–4096
deviceobjectNoDefault: {}
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
statusenumNoValues: "subscribed", "unsubscribed"
opt_inobjectNo
opt_in.sourcestringYesLength: 1–100
opt_in.atstring (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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
user_idstring | nullYes
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
unsubscribe_reasonenum | nullYes
deviceobjectYes
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanYes
test_device_namestring | nullYes
last_active_atstringYes
last_sent_atstring | nullYes
last_delivered_atstring | nullYes
opted_in_atstring | nullYes
opt_in_sourcestring | nullYes
unsubscribed_atstring | nullYes
locationobject | nullYes
created_atstringYes

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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
channelqueryenumNoValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber""ios_push"
statusqueryenumNoValues: "subscribed", "unsubscribed", "invalid", "pending""subscribed"
test_devicequeryenumNoValues: "true", "false""true"
sincequerystring (date-time)No"2026-10-17T09:00:00Z"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SubscriptionList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].user_idstring | nullYes
data[].channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
data[].tokenstringYes
data[].statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
data[].unsubscribe_reasonenum | nullYes
data[].deviceobjectYes
data[].device.modelstringNoLength: 0–100
data[].device.osstringNoLength: 0–50
data[].device.os_versionstringNoLength: 0–50
data[].device.app_versionstring | nullNo
data[].device.sdk_versionstringNoLength: 0–50
data[].device.sdk_platformstringNoLength: 0–50
data[].device.carrierstringNoLength: 0–100
data[].device.localestringNoLength: 0–20
data[].device.timezonestringNoLength: 0–64
data[].device.push_capablebooleanNo
data[].device.push_environmentenumNoValues: "sandbox", "production"
data[].device.form_factorenumNoValues: "phone", "watch"
data[].device.push_kindenumNoValues: "alert", "voip", "app_clip"
data[].device.manufacturerstringNoLength: 0–50
data[].device.brandstringNoLength: 0–50
data[].device.romstringNoLength: 0–30
data[].device.rom_versionstringNoLength: 0–30
data[].device.deliveryobjectNo
data[].test_devicebooleanYes
data[].test_device_namestring | nullYes
data[].last_active_atstringYes
data[].last_sent_atstring | nullYes
data[].last_delivered_atstring | nullYes
data[].opted_in_atstring | nullYes
data[].opt_in_sourcestring | nullYes
data[].unsubscribed_atstring | nullYes
data[].locationobject | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PublicCleanupSubscriptionsDto

FieldTypeRequiredDescription
statusenumNoValues: "invalid", "unsubscribed"

Example:

{
  "status": "invalid"
}

Responses

200 — Success.

Schema: CleanupResult

FieldTypeRequiredDescription
deletedintegerYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Subscription

FieldTypeRequiredDescription
idstringYes
app_idstringYes
user_idstring | nullYes
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
unsubscribe_reasonenum | nullYes
deviceobjectYes
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanYes
test_device_namestring | nullYes
last_active_atstringYes
last_sent_atstring | nullYes
last_delivered_atstring | nullYes
opted_in_atstring | nullYes
opt_in_sourcestring | nullYes
unsubscribed_atstring | nullYes
locationobject | nullYes
created_atstringYes

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

PATCH/v1/apps/{appId}/subscriptions/{subscriptionId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PatchSubscriptionDto

FieldTypeRequiredDescription
tokenstringNoLength: 1–4096
deviceobjectNo
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
statusenumNoValues: "subscribed", "unsubscribed"
test_devicebooleanNo
test_device_namestringNoLength: 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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
user_idstring | nullYes
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
unsubscribe_reasonenum | nullYes
deviceobjectYes
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanYes
test_device_namestring | nullYes
last_active_atstringYes
last_sent_atstring | nullYes
last_delivered_atstring | nullYes
opted_in_atstring | nullYes
opt_in_sourcestring | nullYes
unsubscribed_atstring | nullYes
locationobject | nullYes
created_atstringYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: Ok

FieldTypeRequiredDescription
oktrueYes

Example response:

{
  "ok": true
}

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

Examples

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

Identities of the user who owns the subscription

GET/v1/apps/{appId}/subscriptions/{subscriptionId}/user/identityTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: UserIdentity

FieldTypeRequiredDescription
identitymap<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)

PATCH/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

NameInTypeRequiredDescriptionExample
tokenTypepathstringYes"örnek"
tokenpathstringYes"d1f2e3…"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: PatchSubscriptionDto

FieldTypeRequiredDescription
tokenstringNoLength: 1–4096
deviceobjectNo
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
statusenumNoValues: "subscribed", "unsubscribed"
test_devicebooleanNo
test_device_namestringNoLength: 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

FieldTypeRequiredDescription
idstringYes
app_idstringYes
user_idstring | nullYes
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
unsubscribe_reasonenum | nullYes
deviceobjectYes
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanYes
test_device_namestring | nullYes
last_active_atstringYes
last_sent_atstring | nullYes
last_delivered_atstring | nullYes
opted_in_atstring | nullYes
opt_in_sourcestring | nullYes
unsubscribed_atstring | nullYes
locationobject | nullYes
created_atstringYes

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

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

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

Parameters

NameInTypeRequiredDescriptionExample
subscriptionIdpathstringYes"sub_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: SetOwnerDto

FieldTypeRequiredDescription
external_idstringYesLength: 1–255

Example:

{
  "external_id": "user_42"
}

Responses

200 — Success.

Schema: Subscription

FieldTypeRequiredDescription
idstringYes
app_idstringYes
user_idstring | nullYes
channelenumYesValues: "ios_push", "android_push", "hms_push", "adm_push", "wns_push", "web_push", "email", "sms", "whatsapp", "rcs", "telegram", "viber"
tokenstringYes
statusenumYesValues: "subscribed", "unsubscribed", "invalid", "pending"
unsubscribe_reasonenum | nullYes
deviceobjectYes
device.modelstringNoLength: 0–100
device.osstringNoLength: 0–50
device.os_versionstringNoLength: 0–50
device.app_versionstring | nullNo
device.sdk_versionstringNoLength: 0–50
device.sdk_platformstringNoLength: 0–50
device.carrierstringNoLength: 0–100
device.localestringNoLength: 0–20
device.timezonestringNoLength: 0–64
device.push_capablebooleanNo
device.push_environmentenumNoValues: "sandbox", "production"
device.form_factorenumNoValues: "phone", "watch"
device.push_kindenumNoValues: "alert", "voip", "app_clip"
device.manufacturerstringNoLength: 0–50
device.brandstringNoLength: 0–50
device.romstringNoLength: 0–30
device.rom_versionstringNoLength: 0–30
device.deliveryobjectNo
device.delivery.battery_optimization_exemptbooleanNo
device.delivery.background_restrictedbooleanNo
device.delivery.channel_blockedbooleanNo
device.delivery.power_save_modebooleanNo
device.delivery.data_saverbooleanNo
device.delivery.standby_bucketenumNoValues: "exempted", "active", "working_set", "frequent", "rare", "restricted"
test_devicebooleanYes
test_device_namestring | nullYes
last_active_atstringYes
last_sent_atstring | nullYes
last_delivered_atstring | nullYes
opted_in_atstring | nullYes
opt_in_sourcestring | nullYes
unsubscribed_atstring | nullYes
locationobject | nullYes
created_atstringYes

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)

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

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: ApiEventsDto

FieldTypeRequiredDescription
eventsarray<object>YesItems: 1–500
events[].namestringYesLength: 1–100
events[].propertiesmap<string, any>NoDefault: {}
events[].valuenumberNo
events[].occurred_atstring (date-time)No
events[].event_idstringNoLength: 8–64
events[].subscription_idstringNoLength: 1–∞
events[].external_idstringNoLength: 1–255

Example:

{
  "events": [
    {
      "name": "purchase",
      "properties": {},
      "value": 149.9,
      "occurred_at": "2026-10-17T09:00:00Z"
    }
  ]
}

Responses

200 — Success.

Schema: EventsAccepted

FieldTypeRequiredDescription
acceptedintegerYes

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"
    }
  ]
}'

On this page

OperationsDetailsList companies200 — Success.Create or update a company (by external_id)201 — Success.Bulk create or update companies200 — Success.Get a company200 — Success.Update a company200 — Success.Delete a company200 — Success.List company members200 — Success.Add members to a company in bulk200 — Success.Add a user to a company or change their role200 — Success.Remove a user from a company200 — Success.List a user's companies200 — Success.List a user's companies (by external_id or alias)200 — Success.List users200 — Success.Create/update a user (by external_id, optionally with subscriptions)201 — Success.Search users with a segment definition200 — Success.User by alias (hs_id, external_id or a custom label)200 — Success.Tag/property merge-patch and deltas200 — Success.Delete a user (subscriptions are deleted, events are anonymized)200 — Success.All identities of the user (hs_id, external_id, custom aliases)200 — Success.Add an alias200 — Success.Export user data (KVKK/GDPR portability): profile, aliases, subscriptions, recent events200 — Success.The user's event and delivery timeline (newest 40 entries)200 — Success.The user's recent events200 — Success.The user's recent messages (deliveries, newest first)200 — Success.Remove an alias200 — Success.Add a subscription to the user201 — Success.List subscriptions (channel/status/test device filters; only the last 8 characters of the token are returned)200 — Success.Bulk cleanup: delete invalid (or unsubscribed) subscriptions200 — Success.Subscription details200 — Success.Update a subscription200 — Success.Delete a subscription200 — Success.Identities of the user who owns the subscription200 — Success.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)200 — Success.Link the subscription to a user by external_id200 — Success.Send events in bulk (up to 500)200 — Success.