PushizoDocs
API reference

In-app messages

In-app messages — 7 operations (GET /v1/apps/{appId}/in-app-messages, POST /v1/apps/{appId}/in-app-messages, GET /v1/apps/{appId}/in-app-messages/{messageId}, …). Generated from the OpenAPI 3.1.0 contract.

In-app message definitions (modal/banner/full screen), triggers, status changes and A/B winner selection.

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

Operations

MethodPathOperation
GET/v1/apps/{appId}/in-app-messagesIn-app messages (status filter; statistics included)
POST/v1/apps/{appId}/in-app-messagesCreate an in-app message (draft)
GET/v1/apps/{appId}/in-app-messages/{messageId}In-app message details and statistics
PATCH/v1/apps/{appId}/in-app-messages/{messageId}Edit an in-app message
DELETE/v1/apps/{appId}/in-app-messages/{messageId}Delete an in-app message
POST/v1/apps/{appId}/in-app-messages/{messageId}/statusPublish / pause / archive
POST/v1/apps/{appId}/in-app-messages/{messageId}/winnerPick the A/B winner manually

Details

In-app messages (status filter; statistics included)

GET/v1/apps/{appId}/in-app-messagesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
limitqueryintegerNoDefault: 50; Range: 1–20050
cursorquerystringNoLength: 1–∞"eyJpZCI6Im1zZ18wMUpE…"
statusqueryenumNoValues: "draft", "active", "paused", "archived""draft"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InAppMessagePage

FieldTypeRequiredDescription
dataarray<object>Yes
data[].idstringYes
data[].app_idstringYes
data[].namestringYes
data[].statusenumYesValues: "draft", "active", "paused", "archived"
data[].priorityintegerYes
data[].triggersarray<object>Yes
data[].trigger_groupsarray<array<object>> | nullYes
data[].variantsarray<object>Yes
data[].variants[].idstringYesLength: 1–64
data[].variants[].namestringYesLength: 1–60
data[].variants[].weight_percentintegerYesRange: 1–99
data[].variants[].displayobjectYes
data[].displayobjectYes
data[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
data[].display.background_colorstringNo
data[].display.text_colorstringNo
data[].display.dismissiblebooleanNo
data[].display.auto_dismiss_secondsintegerNoRange: 1–120
data[].display.content_typeenumNoValues: "blocks", "html"
data[].display.htmlmap<string, string>No
data[].display.html_heightintegerNoRange: 40–2000
data[].display.blocksarray<object>YesItems: 0–12
data[].audienceobjectYes
data[].audience.included_segmentsarray<string>NoItems: 0–20
data[].audience.excluded_segmentsarray<string>NoItems: 0–20
data[].audience.global_control_exemptbooleanNo
data[].frequencyobjectYes
data[].frequency.max_impressionsintegerNoRange: 1–1000
data[].frequency.min_interval_secondsintegerNoRange: 0–31536000
data[].frequency.stop_after_interactionbooleanNo
data[].journey_onlybooleanYes
data[].placementstring | nullYes
data[].start_atstring | nullYes
data[].end_atstring | nullYes
data[].statsobjectYes
data[].stats.impressionsintegerYes
data[].stats.clicksintegerYes
data[].stats.dismissalsintegerYes
data[].stats.unique_usersintegerYes
data[].stats.ctrnumberYes
data[].variant_statsarray<object>Yes
data[].variant_stats[].variant_idstringYes
data[].variant_stats[].impressionsintegerYes
data[].variant_stats[].clicksintegerYes
data[].variant_stats[].ctrnumberYes
data[].ab_testobjectYes
data[].ab_test.winnerobjectNo
data[].ab_test.winner_variant_idstring | nullYes
data[].ab_test.decided_atstring | nullYes
data[].ab_test.decided_bystring | nullYes
data[].variant_significanceobject | nullYes
data[].created_atstringYes
data[].updated_atstringYes
next_cursorstring | nullYes
has_morebooleanYes

Example response:

{
  "data": [
    {
      "name": "Sipariş bildirimleri",
      "status": "draft",
      "id": "iam_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "priority": 10,
      "triggers": [
        {
          "kind": "session_start"
        }
      ],
      "trigger_groups": [
        [
          {}
        ]
      ],
      "variants": [
        {
          "name": "Sipariş bildirimleri",
          "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "weight_percent": 1,
          "display": {}
        }
      ],
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer",
        "text_color": "değer"
      },
      "audience": {
        "included_segments": [
          "örnek"
        ],
        "excluded_segments": [
          "örnek"
        ]
      },
      "frequency": {
        "max_impressions": 1,
        "min_interval_seconds": 1
      },
      "journey_only": true,
      "placement": "örnek",
      "start_at": "örnek",
      "end_at": "örnek",
      "stats": {
        "impressions": 1,
        "clicks": 1,
        "dismissals": 1,
        "unique_users": 1,
        "ctr": 1.5
      },
      "variant_stats": [
        {
          "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
          "impressions": 1,
          "clicks": 1,
          "ctr": 1.5
        }
      ],
      "ab_test": {
        "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
        "decided_at": "örnek",
        "decided_by": "örnek",
        "winner": {
          "mode": "manual",
          "min_impressions": 10
        }
      },
      "variant_significance": {
        "leader": "örnek",
        "p_value": 149.9,
        "significant": true
      },
      "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/in-app-messages?limit=50" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Create an in-app message (draft)

POST/v1/apps/{appId}/in-app-messagesTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: CreateInAppDto

FieldTypeRequiredDescription
namestringYesLength: 2–100
triggersarray<object>YesItems: 1–5
trigger_groupsarray<array<object>>NoItems: 1–10
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
ab_testobjectNo
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectNo
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectNo
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanNo
placementstring | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "display": {
    "layout": "modal",
    "blocks": [
      {
        "url": "https://pushizo.com/orders/1001",
        "type": "image",
        "alt": {
          "tr": "Siparişiniz yola çıktı",
          "en": "Your order has shipped"
        }
      }
    ],
    "background_color": "değer",
    "text_color": "değer",
    "dismissible": true
  },
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer"
      }
    }
  ],
  "ab_test": {
    "winner": {
      "mode": "manual",
      "min_impressions": 10
    }
  },
  "audience": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "global_control_exempt": true
  },
  "frequency": {
    "max_impressions": 1,
    "min_interval_seconds": 1,
    "stop_after_interaction": true
  }
}

Responses

201 — Success.

Schema: InAppMessage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
triggersarray<object>Yes
trigger_groupsarray<array<object>> | nullYes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectYes
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectYes
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanYes
placementstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.dismissalsintegerYes
stats.unique_usersintegerYes
stats.ctrnumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].ctrnumberYes
ab_testobjectYes
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer",
        "text_color": "değer"
      }
    }
  ],
  "display": {
    "layout": "modal",
    "blocks": [
      {
        "url": "https://pushizo.com/orders/1001",
        "type": "image",
        "alt": {
          "tr": "Siparişiniz yola çıktı",
          "en": "Your order has shipped"
        }
      }
    ],
    "background_color": "değer",
    "text_color": "değer",
    "dismissible": true,
    "auto_dismiss_seconds": 1
  },
  "audience": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "global_control_exempt": true
  },
  "frequency": {
    "max_impressions": 1,
    "min_interval_seconds": 1,
    "stop_after_interaction": true
  },
  "journey_only": true,
  "placement": "örnek",
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "impressions": 1,
    "clicks": 1,
    "dismissals": 1,
    "unique_users": 1,
    "ctr": 1.5
  },
  "variant_stats": [
    {
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "impressions": 1,
      "clicks": 1,
      "ctr": 1.5
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek",
    "winner": {
      "mode": "manual",
      "min_impressions": 10,
      "confidence": 0.99
    }
  },
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "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/in-app-messages" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "display": {
    "layout": "modal",
    "blocks": [
      {
        "url": "https://pushizo.com/orders/1001",
        "type": "image",
        "alt": {
          "tr": "Siparişiniz yola çıktı",
          "en": "Your order has shipped"
        }
      }
    ],
    "background_color": "değer",
    "text_color": "değer",
    "dismissible": true
  },
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer"
      }
    }
  ],
  "ab_test": {
    "winner": {
      "mode": "manual",
      "min_impressions": 10
    }
  },
  "audience": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "global_control_exempt": true
  },
  "frequency": {
    "max_impressions": 1,
    "min_interval_seconds": 1,
    "stop_after_interaction": true
  }
}'

In-app message details and statistics

GET/v1/apps/{appId}/in-app-messages/{messageId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Responses

200 — Success.

Schema: InAppMessage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
triggersarray<object>Yes
trigger_groupsarray<array<object>> | nullYes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectYes
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectYes
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanYes
placementstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.dismissalsintegerYes
stats.unique_usersintegerYes
stats.ctrnumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].ctrnumberYes
ab_testobjectYes
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer",
        "text_color": "değer"
      }
    }
  ],
  "display": {
    "layout": "modal",
    "blocks": [
      {
        "url": "https://pushizo.com/orders/1001",
        "type": "image",
        "alt": {
          "tr": "Siparişiniz yola çıktı",
          "en": "Your order has shipped"
        }
      }
    ],
    "background_color": "değer",
    "text_color": "değer",
    "dismissible": true,
    "auto_dismiss_seconds": 1
  },
  "audience": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "global_control_exempt": true
  },
  "frequency": {
    "max_impressions": 1,
    "min_interval_seconds": 1,
    "stop_after_interaction": true
  },
  "journey_only": true,
  "placement": "örnek",
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "impressions": 1,
    "clicks": 1,
    "dismissals": 1,
    "unique_users": 1,
    "ctr": 1.5
  },
  "variant_stats": [
    {
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "impressions": 1,
      "clicks": 1,
      "ctr": 1.5
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek",
    "winner": {
      "mode": "manual",
      "min_impressions": 10,
      "confidence": 0.99
    }
  },
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "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/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Edit an in-app message

PATCH/v1/apps/{appId}/in-app-messages/{messageId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: UpdateInAppDto

FieldTypeRequiredDescription
namestringNoLength: 2–100
triggersarray<object>NoItems: 1–5
trigger_groupsarray<array<object>>NoItems: 1–10
variantsarray<object>NoItems: 0–10
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
ab_testobjectNo
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
displayobjectNo
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectNo
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectNo
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanNo
placementstring | nullNo
priorityintegerNoRange: 0–100
start_atstring (date-time) | nullNo
end_atstring (date-time) | nullNo

Example:

{
  "name": "Sipariş bildirimleri",
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer"
      }
    }
  ],
  "ab_test": {
    "winner": {
      "mode": "manual",
      "min_impressions": 10
    }
  }
}

Responses

200 — Success.

Schema: InAppMessage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
triggersarray<object>Yes
trigger_groupsarray<array<object>> | nullYes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectYes
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectYes
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanYes
placementstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.dismissalsintegerYes
stats.unique_usersintegerYes
stats.ctrnumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].ctrnumberYes
ab_testobjectYes
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer",
        "text_color": "değer"
      }
    }
  ],
  "display": {
    "layout": "modal",
    "blocks": [
      {
        "url": "https://pushizo.com/orders/1001",
        "type": "image",
        "alt": {
          "tr": "Siparişiniz yola çıktı",
          "en": "Your order has shipped"
        }
      }
    ],
    "background_color": "değer",
    "text_color": "değer",
    "dismissible": true,
    "auto_dismiss_seconds": 1
  },
  "audience": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "global_control_exempt": true
  },
  "frequency": {
    "max_impressions": 1,
    "min_interval_seconds": 1,
    "stop_after_interaction": true
  },
  "journey_only": true,
  "placement": "örnek",
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "impressions": 1,
    "clicks": 1,
    "dismissals": 1,
    "unique_users": 1,
    "ctr": 1.5
  },
  "variant_stats": [
    {
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "impressions": 1,
      "clicks": 1,
      "ctr": 1.5
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek",
    "winner": {
      "mode": "manual",
      "min_impressions": 10,
      "confidence": 0.99
    }
  },
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "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/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Sipariş bildirimleri",
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer"
      }
    }
  ],
  "ab_test": {
    "winner": {
      "mode": "manual",
      "min_impressions": 10
    }
  }
}'

Delete an in-app message

DELETE/v1/apps/{appId}/in-app-messages/{messageId}Try it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_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/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY"

Publish / pause / archive

POST/v1/apps/{appId}/in-app-messages/{messageId}/statusTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: InAppStatusDto

FieldTypeRequiredDescription
statusenumYesValues: "draft", "active", "paused", "archived"

Example:

{
  "status": "draft"
}

Responses

200 — Success.

Schema: InAppMessage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
triggersarray<object>Yes
trigger_groupsarray<array<object>> | nullYes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectYes
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectYes
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanYes
placementstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.dismissalsintegerYes
stats.unique_usersintegerYes
stats.ctrnumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].ctrnumberYes
ab_testobjectYes
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer",
        "text_color": "değer"
      }
    }
  ],
  "display": {
    "layout": "modal",
    "blocks": [
      {
        "url": "https://pushizo.com/orders/1001",
        "type": "image",
        "alt": {
          "tr": "Siparişiniz yola çıktı",
          "en": "Your order has shipped"
        }
      }
    ],
    "background_color": "değer",
    "text_color": "değer",
    "dismissible": true,
    "auto_dismiss_seconds": 1
  },
  "audience": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "global_control_exempt": true
  },
  "frequency": {
    "max_impressions": 1,
    "min_interval_seconds": 1,
    "stop_after_interaction": true
  },
  "journey_only": true,
  "placement": "örnek",
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "impressions": 1,
    "clicks": 1,
    "dismissals": 1,
    "unique_users": 1,
    "ctr": 1.5
  },
  "variant_stats": [
    {
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "impressions": 1,
      "clicks": 1,
      "ctr": 1.5
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek",
    "winner": {
      "mode": "manual",
      "min_impressions": 10,
      "confidence": 0.99
    }
  },
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "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/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/status" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "draft"
}'

Pick the A/B winner manually

POST/v1/apps/{appId}/in-app-messages/{messageId}/winnerTry it (interactive API docs, new tab)

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

Parameters

NameInTypeRequiredDescriptionExample
messageIdpathstringYes"msg_01JD3W5Q7X9K2M4N6P8R0T1V3W"
appIdpathstringYes"app_01JD3W5Q7X9K2M4N6P8R0T1V3W"

Request body (required)

Schema: InAppWinnerDto

FieldTypeRequiredDescription
variant_idstringYesLength: 1–64

Example:

{
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}

Responses

200 — Success.

Schema: InAppMessage

FieldTypeRequiredDescription
idstringYes
app_idstringYes
namestringYes
statusenumYesValues: "draft", "active", "paused", "archived"
priorityintegerYes
triggersarray<object>Yes
trigger_groupsarray<array<object>> | nullYes
variantsarray<object>Yes
variants[].idstringYesLength: 1–64
variants[].namestringYesLength: 1–60
variants[].weight_percentintegerYesRange: 1–99
variants[].displayobjectYes
variants[].display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
variants[].display.background_colorstringNo
variants[].display.text_colorstringNo
variants[].display.dismissiblebooleanNo
variants[].display.auto_dismiss_secondsintegerNoRange: 1–120
variants[].display.content_typeenumNoValues: "blocks", "html"
variants[].display.htmlmap<string, string>No
variants[].display.html_heightintegerNoRange: 40–2000
variants[].display.blocksarray<object>YesItems: 0–12
displayobjectYes
display.layoutenumYesValues: "modal", "banner_top", "banner_bottom", "fullscreen"
display.background_colorstringNo
display.text_colorstringNo
display.dismissiblebooleanNo
display.auto_dismiss_secondsintegerNoRange: 1–120
display.content_typeenumNoValues: "blocks", "html"
display.htmlmap<string, string>No
display.html_heightintegerNoRange: 40–2000
display.blocksarray<object>YesItems: 0–12
audienceobjectYes
audience.included_segmentsarray<string>NoItems: 0–20
audience.excluded_segmentsarray<string>NoItems: 0–20
audience.global_control_exemptbooleanNo
frequencyobjectYes
frequency.max_impressionsintegerNoRange: 1–1000
frequency.min_interval_secondsintegerNoRange: 0–31536000
frequency.stop_after_interactionbooleanNo
journey_onlybooleanYes
placementstring | nullYes
start_atstring | nullYes
end_atstring | nullYes
statsobjectYes
stats.impressionsintegerYes
stats.clicksintegerYes
stats.dismissalsintegerYes
stats.unique_usersintegerYes
stats.ctrnumberYes
variant_statsarray<object>Yes
variant_stats[].variant_idstringYes
variant_stats[].impressionsintegerYes
variant_stats[].clicksintegerYes
variant_stats[].ctrnumberYes
ab_testobjectYes
ab_test.winnerobjectNo
ab_test.winner.modeenumYesValues: "manual", "auto"
ab_test.winner.min_impressionsintegerNoRange: 10–1000000
ab_test.winner.confidencenumberNoRange: 0.8–0.99
ab_test.winner_variant_idstring | nullYes
ab_test.decided_atstring | nullYes
ab_test.decided_bystring | nullYes
variant_significanceobject | nullYes
created_atstringYes
updated_atstringYes

Example response:

{
  "name": "Sipariş bildirimleri",
  "status": "draft",
  "id": "msg_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
  "priority": 10,
  "triggers": [
    {
      "kind": "session_start"
    }
  ],
  "trigger_groups": [
    [
      {
        "kind": "session_start"
      }
    ]
  ],
  "variants": [
    {
      "name": "Sipariş bildirimleri",
      "id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "weight_percent": 1,
      "display": {
        "layout": "modal",
        "blocks": [
          {}
        ],
        "background_color": "değer",
        "text_color": "değer"
      }
    }
  ],
  "display": {
    "layout": "modal",
    "blocks": [
      {
        "url": "https://pushizo.com/orders/1001",
        "type": "image",
        "alt": {
          "tr": "Siparişiniz yola çıktı",
          "en": "Your order has shipped"
        }
      }
    ],
    "background_color": "değer",
    "text_color": "değer",
    "dismissible": true,
    "auto_dismiss_seconds": 1
  },
  "audience": {
    "included_segments": [
      "örnek"
    ],
    "excluded_segments": [
      "örnek"
    ],
    "global_control_exempt": true
  },
  "frequency": {
    "max_impressions": 1,
    "min_interval_seconds": 1,
    "stop_after_interaction": true
  },
  "journey_only": true,
  "placement": "örnek",
  "start_at": "örnek",
  "end_at": "örnek",
  "stats": {
    "impressions": 1,
    "clicks": 1,
    "dismissals": 1,
    "unique_users": 1,
    "ctr": 1.5
  },
  "variant_stats": [
    {
      "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
      "impressions": 1,
      "clicks": 1,
      "ctr": 1.5
    }
  ],
  "ab_test": {
    "winner_variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W",
    "decided_at": "örnek",
    "decided_by": "örnek",
    "winner": {
      "mode": "manual",
      "min_impressions": 10,
      "confidence": 0.99
    }
  },
  "variant_significance": {
    "leader": "örnek",
    "p_value": 149.9,
    "significant": true
  },
  "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/in-app-messages/msg_01JD3W5Q7X9K2M4N6P8R0T1V3W/winner" \
  -H "Authorization: Bearer $PUSHIZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "variant_id": "var_01JD3W5Q7X9K2M4N6P8R0T1V3W"
}'

On this page