PushizoDocs
API reference

Apps

Apps — 9 operations (GET /v1/apps/{appId}/sdk-errors, GET /v1/organization, GET /v1/organization/members, …). Generated from the OpenAPI 3.1.0 contract.

Apps in the organization (the products notifications are sent for). Listing and creating apps require an org-wide admin key; app settings and data cleanup can also be done with an app key.

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

Operations

Details

SDK error reports (last 7 days, cursor)

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

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
platformquerystringNoLength: 0–20"örnek"
levelqueryenumNoValues: "error", "warning""error"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: SdkErrorPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].subscription_idstring | nullYes
data[].platformstringYes
data[].sdk_versionstring | nullYes
data[].levelstringYes
data[].codestring | nullYes
data[].messagestringYes
data[].contextmap<string, any>Yes
data[].occurred_atstringYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "subscription_id": "sub_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "platform": "örnek",
      "sdk_version": "örnek",
      "level": "örnek",
      "code": "örnek",
      "message": "Takip bağlantısı içeride",
      "context": {
        "key": "örnek"
      },
      "occurred_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/sdk-errors?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Organization that owns the key (org-wide admin key)

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

Responses

200 — Success.

Schema: Org

FieldTypeRequiredDescription
idstringYes
namestringYes
slugstringYes
plan_codestringYes
statusenumYesValues: "active", "suspended", "deleted"
settingsobjectYes
settings.mfaRequiredbooleanNo
settings.ipAllowlistarray<string>NoItems: 0–50
settings.retentionDaysintegerNoRange: 7–3650
settings.sessionMaxHoursintegerNoRange: 1–2160
settings.auditStreamobjectNo
settings.auditStream.s3booleanNo
settings.auditStream.webhookAppIdstring | nullNo
created_atstringYes
regionstring | nullYes
managed_by_resellerbooleanYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "plan_code": "örnek",
  "settings": {
    "mfaRequired": true,
    "ipAllowlist": [
      "örnek"
    ],
    "retentionDays": 7,
    "sessionMaxHours": 1
  },
  "created_at": "örnek",
  "region": "örnek",
  "managed_by_reseller": 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/organization" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Organization members (org-wide admin key)

GET/v1/organization/membersTry it (interactive API docs, new tab)

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

Responses

200 — Success.

Schema: MemberList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].account_idstringYes
data[].emailstringYes
data[].namestringYes
data[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
data[].app_scopesarray<string>Yes
data[].app_rolesarray<object>Yes
data[].app_roles[].app_idstringYes
data[].app_roles[].roleenumYesValues: "owner", "admin", "developer", "marketer", "analyst", "billing", "viewer", "composer", "agent"
data[].accepted_atstring | nullYes
data[].created_atstringYes
data[].last_login_atstring | nullYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "account_id": "ada_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "email": "ayse@pushizo.com",
      "role": "owner",
      "app_scopes": [
        "örnek"
      ],
      "app_roles": [
        {
          "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "role": "owner"
        }
      ],
      "accepted_at": "örnek",
      "created_at": "örnek",
      "last_login_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/organization/members" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Audit log (org-wide admin key; action/actor/app/date filters, cursor)

GET/v1/organization/audit-logsTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
actionquerystringNoLength: 1–100"örnek"
actor_idquerystringNoLength: 1–64"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
app_idquerystringNoLength: 1–64"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
fromquerystring (date-time)No"2026-10-17T09:00:00Z"
toquerystring (date-time)No"2026-10-17T09:00:00Z"

Responses

200 — Success.

Schema: AuditPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].org_idstringYes
data[].app_idstring | nullYes
data[].actor_typeenumYesValues: "account", "api_key", "system"
data[].actor_idstring | nullYes
data[].actionstringYes
data[].target_typestring | nullYes
data[].target_idstring | nullYes
data[].metadatamap<string, any>Yes
data[].ipstring | nullYes
data[].request_idstring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "actor_type": "account",
      "actor_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "action": "örnek",
      "target_type": "örnek",
      "target_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "metadata": {
        "order_id": "1001"
      },
      "ip": "örnek",
      "request_id": "req_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "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/organization/audit-logs?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Public API request logs (organization-wide admin key; last 7 days, cursor)

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
app_idquerystringNoLength: 1–64"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"
status_classqueryenumNoValues: "2xx", "4xx", "5xx""2xx"
methodqueryenumNoValues: "GET", "POST", "PUT", "PATCH", "DELETE""GET"

Responses

200 — Success.

Schema: RequestLogPage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].org_idstringYes
data[].app_idstring | nullYes
data[].api_key_idstring | nullYes
data[].methodstringYes
data[].pathstringYes
data[].routestring | nullYes
data[].statusintegerYes
data[].duration_msintegerYes
data[].request_idstring | nullYes
data[].ipstring | nullYes
data[].error_codestring | nullYes
data[].created_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "status": 1,
      "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "api_key_id": "key_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "method": "örnek",
      "path": "örnek",
      "route": "örnek",
      "duration_ms": 1,
      "request_id": "req_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "ip": "örnek",
      "error_code": "ö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/organization/logs?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

List apps (org-wide admin key)

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

Responses

200 — Success.

Schema: AppList

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].org_idstringYes
data[].namestringYes
data[].slugstringYes
data[].platform_flagsobjectYes
data[].platform_flags.iosbooleanNo
data[].platform_flags.androidbooleanNo
data[].platform_flags.webbooleanNo
data[].platform_flags.emailbooleanNo
data[].platform_flags.smsbooleanNo
data[].icon_urlstring | nullYes
data[].default_languagestringYes
data[].timezonestringYes
data[].settingsobjectYes
data[].settings.quietHoursobject | nullNo
data[].settings.frequencyCapobject | nullNo
data[].settings.frequencyCapsarray<object>NoItems: 0–10
data[].settings.inAppobjectNo
data[].settings.androidChannelsarray<object>NoItems: 0–50
data[].settings.smsobjectNo
data[].settings.preferenceCenterobjectNo
data[].settings.brandKitobjectNo
data[].settings.defaultTtlSecondsintegerNoRange: 60–2419200
data[].settings.identityVerificationRequiredbooleanNo
data[].settings.ipCaptureenumNoValues: "off", "full", "masked"
data[].settings.ipRetentionDaysintegerNoRange: 1–365
data[].settings.adaptiveFrequencyobjectNo
data[].settings.allowedOriginsarray<string>NoItems: 0–50
data[].settings.campaignApprovalRequiredbooleanNo
data[].settings.webPushobjectNo
data[].settings.onboardingobjectNo
data[].settings.sdkSetupobject | nullNo
data[].identity_verification_modeenumYesValues: "hmac", "jwt", "both"
data[].statusenumYesValues: "active", "suspended", "deleted"
data[].created_atstringYes
data[].updated_atstringYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "status": "active",
      "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "slug": "magaza",
      "platform_flags": {
        "ios": true,
        "android": true
      },
      "icon_url": "https://pushizo.com/orders/1001",
      "default_language": "örnek",
      "timezone": "Europe/Istanbul",
      "settings": {
        "quietHours": {
          "start": "2026-10-01T00:00:00Z",
          "end": "2026-10-17T00:00:00Z",
          "timezoneMode": "user"
        },
        "frequencyCap": {
          "max": 1,
          "windowHours": 1
        }
      },
      "identity_verification_mode": "hmac",
      "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" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create an app (org-wide admin key)

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

Request body (required)

Schema: CreateAppDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
slugstringNo
platform_flagsobjectNoDefault: {}
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
default_languagestringNoDefault: "en"; Length: 2–10
timezonestringNoDefault: "UTC"; Length: 1–64

Example:

{
  "name": "Sipariş bildirimleri",
  "slug": "magaza",
  "platform_flags": {},
  "default_language": "en",
  "timezone": "UTC"
}

Responses

201 — Success.

Schema: App

FieldTypeRequiredDescription
idstringYes
org_idstringYes
namestringYes
slugstringYes
platform_flagsobjectYes
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
icon_urlstring | nullYes
default_languagestringYes
timezonestringYes
settingsobjectYes
settings.quietHoursobject | nullNo
settings.frequencyCapobject | nullNo
settings.frequencyCapsarray<object>NoItems: 0–10
settings.frequencyCaps[].maxintegerYesRange: 1–1000
settings.frequencyCaps[].windowobjectYes
settings.frequencyCaps[].channelsarray<enum>NoItems: 1–12
settings.inAppobjectNo
settings.inApp.minIntervalSecondsintegerNoRange: 0–604800
settings.androidChannelsarray<object>NoItems: 0–50
settings.androidChannels[].idstringYesLength: 1–64
settings.androidChannels[].namestringYesLength: 1–60
settings.androidChannels[].descriptionstringNoLength: 0–200
settings.androidChannels[].importanceenumYesValues: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringNoLength: 0–64
settings.androidChannels[].vibrationbooleanNo
settings.androidChannels[].groupstringNoLength: 0–64
settings.smsobjectNo
settings.sms.helpReplystringNoLength: 0–320
settings.sms.stopReplystringNoLength: 0–320
settings.sms.autoReplybooleanNo
settings.preferenceCenterobjectNo
settings.preferenceCenter.enabledbooleanNo
settings.preferenceCenter.brandNamestringNoLength: 0–80
settings.preferenceCenter.logoUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.accentColorstringNo
settings.preferenceCenter.customUnsubscribeUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.textsmap<string, object>No
settings.brandKitobjectNo
settings.brandKit.website_urlstring (url)NoLength: 0–2000
settings.brandKit.namestringNoLength: 0–80
settings.brandKit.primary_colorstringNo
settings.brandKit.accent_colorstringNo
settings.brandKit.fontstringNoLength: 0–40
settings.brandKit.logo_urlstring (url)NoLength: 0–2000
settings.brandKit.tonestringNoLength: 0–240
settings.defaultTtlSecondsintegerNoRange: 60–2419200
settings.identityVerificationRequiredbooleanNo
settings.ipCaptureenumNoValues: "off", "full", "masked"
settings.ipRetentionDaysintegerNoRange: 1–365
settings.adaptiveFrequencyobjectNo
settings.adaptiveFrequency.enabledbooleanYes
settings.adaptiveFrequency.minintegerYesRange: 1–50
settings.adaptiveFrequency.maxintegerYesRange: 1–50
settings.allowedOriginsarray<string>NoItems: 0–50
settings.campaignApprovalRequiredbooleanNo
settings.webPushobjectNo
settings.webPush.serviceWorkerPathstringNoLength: 0–200
settings.webPush.serviceWorkerScopestringNoLength: 0–200
settings.webPush.promptobjectNo
settings.webPush.welcomeNotificationobjectNo
settings.webPush.clickBehaviorobjectNo
settings.webPush.customLinkobjectNo
settings.webPush.promptBackoffDaysarray<integer>NoItems: 0–10
settings.onboardingobjectNo
settings.onboarding.stepintegerYesRange: 0–6
settings.onboarding.simulationbooleanNo
settings.onboarding.completed_atstring | nullNo
settings.onboarding.versionintegerNoRange: 1–100
settings.onboarding.platformsarray<enum>NoItems: 0–8
settings.onboarding.frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumNoValues: "code", "wordpress"
settings.sdkSetupobject | nullNo
identity_verification_modeenumYesValues: "hmac", "jwt", "both"
statusenumYesValues: "active", "suspended", "deleted"
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "platform_flags": {
    "ios": true,
    "android": true,
    "web": true,
    "email": true
  },
  "icon_url": "https://pushizo.com/orders/1001",
  "default_language": "örnek",
  "timezone": "Europe/Istanbul",
  "settings": {
    "quietHours": {
      "start": "2026-10-01T00:00:00Z",
      "end": "2026-10-17T00:00:00Z",
      "timezoneMode": "user"
    },
    "frequencyCap": {
      "max": 1,
      "windowHours": 1
    },
    "frequencyCaps": [
      {
        "max": 1,
        "window": {
          "value": 150,
          "unit": "minutes"
        },
        "channels": [
          "ios_push"
        ]
      }
    ],
    "inApp": {
      "minIntervalSeconds": 1
    }
  },
  "identity_verification_mode": "hmac",
  "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" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "slug": "magaza",
  "platform_flags": {},
  "default_language": "en",
  "timezone": "UTC"
}'

App details

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: App

FieldTypeRequiredDescription
idstringYes
org_idstringYes
namestringYes
slugstringYes
platform_flagsobjectYes
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
icon_urlstring | nullYes
default_languagestringYes
timezonestringYes
settingsobjectYes
settings.quietHoursobject | nullNo
settings.frequencyCapobject | nullNo
settings.frequencyCapsarray<object>NoItems: 0–10
settings.frequencyCaps[].maxintegerYesRange: 1–1000
settings.frequencyCaps[].windowobjectYes
settings.frequencyCaps[].channelsarray<enum>NoItems: 1–12
settings.inAppobjectNo
settings.inApp.minIntervalSecondsintegerNoRange: 0–604800
settings.androidChannelsarray<object>NoItems: 0–50
settings.androidChannels[].idstringYesLength: 1–64
settings.androidChannels[].namestringYesLength: 1–60
settings.androidChannels[].descriptionstringNoLength: 0–200
settings.androidChannels[].importanceenumYesValues: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringNoLength: 0–64
settings.androidChannels[].vibrationbooleanNo
settings.androidChannels[].groupstringNoLength: 0–64
settings.smsobjectNo
settings.sms.helpReplystringNoLength: 0–320
settings.sms.stopReplystringNoLength: 0–320
settings.sms.autoReplybooleanNo
settings.preferenceCenterobjectNo
settings.preferenceCenter.enabledbooleanNo
settings.preferenceCenter.brandNamestringNoLength: 0–80
settings.preferenceCenter.logoUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.accentColorstringNo
settings.preferenceCenter.customUnsubscribeUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.textsmap<string, object>No
settings.brandKitobjectNo
settings.brandKit.website_urlstring (url)NoLength: 0–2000
settings.brandKit.namestringNoLength: 0–80
settings.brandKit.primary_colorstringNo
settings.brandKit.accent_colorstringNo
settings.brandKit.fontstringNoLength: 0–40
settings.brandKit.logo_urlstring (url)NoLength: 0–2000
settings.brandKit.tonestringNoLength: 0–240
settings.defaultTtlSecondsintegerNoRange: 60–2419200
settings.identityVerificationRequiredbooleanNo
settings.ipCaptureenumNoValues: "off", "full", "masked"
settings.ipRetentionDaysintegerNoRange: 1–365
settings.adaptiveFrequencyobjectNo
settings.adaptiveFrequency.enabledbooleanYes
settings.adaptiveFrequency.minintegerYesRange: 1–50
settings.adaptiveFrequency.maxintegerYesRange: 1–50
settings.allowedOriginsarray<string>NoItems: 0–50
settings.campaignApprovalRequiredbooleanNo
settings.webPushobjectNo
settings.webPush.serviceWorkerPathstringNoLength: 0–200
settings.webPush.serviceWorkerScopestringNoLength: 0–200
settings.webPush.promptobjectNo
settings.webPush.welcomeNotificationobjectNo
settings.webPush.clickBehaviorobjectNo
settings.webPush.customLinkobjectNo
settings.webPush.promptBackoffDaysarray<integer>NoItems: 0–10
settings.onboardingobjectNo
settings.onboarding.stepintegerYesRange: 0–6
settings.onboarding.simulationbooleanNo
settings.onboarding.completed_atstring | nullNo
settings.onboarding.versionintegerNoRange: 1–100
settings.onboarding.platformsarray<enum>NoItems: 0–8
settings.onboarding.frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumNoValues: "code", "wordpress"
settings.sdkSetupobject | nullNo
identity_verification_modeenumYesValues: "hmac", "jwt", "both"
statusenumYesValues: "active", "suspended", "deleted"
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "platform_flags": {
    "ios": true,
    "android": true,
    "web": true,
    "email": true
  },
  "icon_url": "https://pushizo.com/orders/1001",
  "default_language": "örnek",
  "timezone": "Europe/Istanbul",
  "settings": {
    "quietHours": {
      "start": "2026-10-01T00:00:00Z",
      "end": "2026-10-17T00:00:00Z",
      "timezoneMode": "user"
    },
    "frequencyCap": {
      "max": 1,
      "windowHours": 1
    },
    "frequencyCaps": [
      {
        "max": 1,
        "window": {
          "value": 150,
          "unit": "minutes"
        },
        "channels": [
          "ios_push"
        ]
      }
    ],
    "inApp": {
      "minIntervalSeconds": 1
    }
  },
  "identity_verification_mode": "hmac",
  "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" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Update app settings

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateAppDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
platform_flagsobjectNo
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
icon_urlstring (uri) | nullNo
default_languagestringNoLength: 2–10
timezonestringNoLength: 1–64
settingsobjectNo
settings.quietHoursobject | nullNo
settings.frequencyCapobject | nullNo
settings.frequencyCapsarray<object>NoItems: 0–10
settings.frequencyCaps[].maxintegerYesRange: 1–1000
settings.frequencyCaps[].windowobjectYes
settings.frequencyCaps[].window.valueintegerYesRange: 1–366
settings.frequencyCaps[].window.unitenumYesValues: "minutes", "hours", "days", "weeks"
settings.frequencyCaps[].channelsarray<enum>NoItems: 1–12
settings.inAppobjectNo
settings.inApp.minIntervalSecondsintegerNoRange: 0–604800
settings.androidChannelsarray<object>NoItems: 0–50
settings.androidChannels[].idstringYesLength: 1–64
settings.androidChannels[].namestringYesLength: 1–60
settings.androidChannels[].descriptionstringNoLength: 0–200
settings.androidChannels[].importanceenumYesValues: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringNoLength: 0–64
settings.androidChannels[].vibrationbooleanNo
settings.androidChannels[].groupstringNoLength: 0–64
settings.smsobjectNo
settings.sms.helpReplystringNoLength: 0–320
settings.sms.stopReplystringNoLength: 0–320
settings.sms.autoReplybooleanNo
settings.preferenceCenterobjectNo
settings.preferenceCenter.enabledbooleanNo
settings.preferenceCenter.brandNamestringNoLength: 0–80
settings.preferenceCenter.logoUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.accentColorstringNo
settings.preferenceCenter.customUnsubscribeUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.textsmap<string, object>No
settings.brandKitobjectNo
settings.brandKit.website_urlstring (url)NoLength: 0–2000
settings.brandKit.namestringNoLength: 0–80
settings.brandKit.primary_colorstringNo
settings.brandKit.accent_colorstringNo
settings.brandKit.fontstringNoLength: 0–40
settings.brandKit.logo_urlstring (url)NoLength: 0–2000
settings.brandKit.tonestringNoLength: 0–240
settings.defaultTtlSecondsintegerNoRange: 60–2419200
settings.identityVerificationRequiredbooleanNo
settings.ipCaptureenumNoValues: "off", "full", "masked"
settings.ipRetentionDaysintegerNoRange: 1–365
settings.adaptiveFrequencyobjectNo
settings.adaptiveFrequency.enabledbooleanYes
settings.adaptiveFrequency.minintegerYesRange: 1–50
settings.adaptiveFrequency.maxintegerYesRange: 1–50
settings.allowedOriginsarray<string>NoItems: 0–50
settings.campaignApprovalRequiredbooleanNo
settings.webPushobjectNo
settings.webPush.serviceWorkerPathstringNoLength: 0–200
settings.webPush.serviceWorkerScopestringNoLength: 0–200
settings.webPush.promptobjectNo
settings.webPush.prompt.enabledbooleanYes
settings.webPush.prompt.typeenumYesValues: "slidedown", "native"
settings.webPush.prompt.collectenumNoValues: "push", "email", "sms", "email_sms"
settings.webPush.prompt.delaySecondsintegerNoRange: 0–600
settings.webPush.prompt.pageViewsintegerNoRange: 1–50
settings.webPush.prompt.scrollPercentintegerNoRange: 1–100
settings.webPush.prompt.textsmap<string, object>No
settings.webPush.prompt.categoriesarray<object>NoItems: 0–10
settings.webPush.prompt.categories[].tagstringYesLength: 1–64
settings.webPush.prompt.categories[].labelmap<string, string>Yes
settings.webPush.prompt.accentColorstringNo
settings.webPush.welcomeNotificationobjectNo
settings.webPush.welcomeNotification.enabledbooleanYes
settings.webPush.welcomeNotification.urlstring (url)NoLength: 0–2000
settings.webPush.welcomeNotification.textsmap<string, object>No
settings.webPush.clickBehaviorobjectNo
settings.webPush.clickBehavior.matchenumYesValues: "exact", "origin"
settings.webPush.clickBehavior.actionenumYesValues: "navigate", "focus"
settings.webPush.customLinkobjectNo
settings.webPush.customLink.enabledbooleanYes
settings.webPush.customLink.styleenumYesValues: "button", "link"
settings.webPush.customLink.sizeenumYesValues: "small", "medium", "large"
settings.webPush.customLink.colorobjectNo
settings.webPush.customLink.color.buttonstringNo
settings.webPush.customLink.color.textstringNo
settings.webPush.customLink.textsmap<string, object>No
settings.webPush.customLink.unsubscribeEnabledbooleanNo
settings.webPush.promptBackoffDaysarray<integer>NoItems: 0–10
settings.onboardingobjectNo
settings.onboarding.stepintegerYesRange: 0–6
settings.onboarding.simulationbooleanNo
settings.onboarding.completed_atstring | nullNo
settings.onboarding.versionintegerNoRange: 1–100
settings.onboarding.platformsarray<enum>NoItems: 0–8
settings.onboarding.frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumNoValues: "code", "wordpress"
settings.sdkSetupobject | nullNo
identity_verification_modeenumNoValues: "hmac", "jwt", "both"

Example:

{
  "name": "Sipariş bildirimleri",
  "platform_flags": {
    "ios": true,
    "android": true,
    "web": true
  },
  "icon_url": "https://pushizo.com/orders/1001",
  "default_language": "örnek",
  "timezone": "Europe/Istanbul"
}

Responses

200 — Success.

Schema: App

FieldTypeRequiredDescription
idstringYes
org_idstringYes
namestringYes
slugstringYes
platform_flagsobjectYes
platform_flags.iosbooleanNo
platform_flags.androidbooleanNo
platform_flags.webbooleanNo
platform_flags.emailbooleanNo
platform_flags.smsbooleanNo
icon_urlstring | nullYes
default_languagestringYes
timezonestringYes
settingsobjectYes
settings.quietHoursobject | nullNo
settings.frequencyCapobject | nullNo
settings.frequencyCapsarray<object>NoItems: 0–10
settings.frequencyCaps[].maxintegerYesRange: 1–1000
settings.frequencyCaps[].windowobjectYes
settings.frequencyCaps[].channelsarray<enum>NoItems: 1–12
settings.inAppobjectNo
settings.inApp.minIntervalSecondsintegerNoRange: 0–604800
settings.androidChannelsarray<object>NoItems: 0–50
settings.androidChannels[].idstringYesLength: 1–64
settings.androidChannels[].namestringYesLength: 1–60
settings.androidChannels[].descriptionstringNoLength: 0–200
settings.androidChannels[].importanceenumYesValues: "low", "default", "high", "urgent"
settings.androidChannels[].soundstringNoLength: 0–64
settings.androidChannels[].vibrationbooleanNo
settings.androidChannels[].groupstringNoLength: 0–64
settings.smsobjectNo
settings.sms.helpReplystringNoLength: 0–320
settings.sms.stopReplystringNoLength: 0–320
settings.sms.autoReplybooleanNo
settings.preferenceCenterobjectNo
settings.preferenceCenter.enabledbooleanNo
settings.preferenceCenter.brandNamestringNoLength: 0–80
settings.preferenceCenter.logoUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.accentColorstringNo
settings.preferenceCenter.customUnsubscribeUrlstring (url)NoLength: 0–2000
settings.preferenceCenter.textsmap<string, object>No
settings.brandKitobjectNo
settings.brandKit.website_urlstring (url)NoLength: 0–2000
settings.brandKit.namestringNoLength: 0–80
settings.brandKit.primary_colorstringNo
settings.brandKit.accent_colorstringNo
settings.brandKit.fontstringNoLength: 0–40
settings.brandKit.logo_urlstring (url)NoLength: 0–2000
settings.brandKit.tonestringNoLength: 0–240
settings.defaultTtlSecondsintegerNoRange: 60–2419200
settings.identityVerificationRequiredbooleanNo
settings.ipCaptureenumNoValues: "off", "full", "masked"
settings.ipRetentionDaysintegerNoRange: 1–365
settings.adaptiveFrequencyobjectNo
settings.adaptiveFrequency.enabledbooleanYes
settings.adaptiveFrequency.minintegerYesRange: 1–50
settings.adaptiveFrequency.maxintegerYesRange: 1–50
settings.allowedOriginsarray<string>NoItems: 0–50
settings.campaignApprovalRequiredbooleanNo
settings.webPushobjectNo
settings.webPush.serviceWorkerPathstringNoLength: 0–200
settings.webPush.serviceWorkerScopestringNoLength: 0–200
settings.webPush.promptobjectNo
settings.webPush.welcomeNotificationobjectNo
settings.webPush.clickBehaviorobjectNo
settings.webPush.customLinkobjectNo
settings.webPush.promptBackoffDaysarray<integer>NoItems: 0–10
settings.onboardingobjectNo
settings.onboarding.stepintegerYesRange: 0–6
settings.onboarding.simulationbooleanNo
settings.onboarding.completed_atstring | nullNo
settings.onboarding.versionintegerNoRange: 1–100
settings.onboarding.platformsarray<enum>NoItems: 0–8
settings.onboarding.frameworkenumNoValues: "native", "flutter", "react-native", "expo", "kmp", "unity", "capacitor", "cordova", "maui"
settings.onboarding.web_integrationenumNoValues: "code", "wordpress"
settings.sdkSetupobject | nullNo
identity_verification_modeenumYesValues: "hmac", "jwt", "both"
statusenumYesValues: "active", "suspended", "deleted"
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "active",
  "id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "org_id": "org_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "slug": "magaza",
  "platform_flags": {
    "ios": true,
    "android": true,
    "web": true,
    "email": true
  },
  "icon_url": "https://pushizo.com/orders/1001",
  "default_language": "örnek",
  "timezone": "Europe/Istanbul",
  "settings": {
    "quietHours": {
      "start": "2026-10-01T00:00:00Z",
      "end": "2026-10-17T00:00:00Z",
      "timezoneMode": "user"
    },
    "frequencyCap": {
      "max": 1,
      "windowHours": 1
    },
    "frequencyCaps": [
      {
        "max": 1,
        "window": {
          "value": 150,
          "unit": "minutes"
        },
        "channels": [
          "ios_push"
        ]
      }
    ],
    "inApp": {
      "minIntervalSeconds": 1
    }
  },
  "identity_verification_mode": "hmac",
  "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" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "platform_flags": {
    "ios": true,
    "android": true,
    "web": true
  },
  "icon_url": "https://pushizo.com/orders/1001",
  "default_language": "örnek",
  "timezone": "Europe/Istanbul"
}'

On this page