In-app messages

The self-contained HTML document for one in-app message, with Liquid already resolved against the given device, a narrow native bridge, safe-area-aware placement and carousel page-change events.

subscription_id is required as a query parameter — the document is personalised, so there is no device-less rendering of it.

In-app message definitions for one app with per-tab counts and a total. status filters by lifecycle tab; omit it for all. The page is capped at 100 rows.

Creates an in-app message definition — layout, blocks, triggers, audience, dismissal, scheduling, frequency, and optional Liquid fields. It is created as a draft unless the body sets live: true, in which case it is taken live in the same call.

One in-app message definition together with its report summary — impressions, clicks and the per-block engagement recorded from device receipts.

Deletes an in-app message definition. Drafts only — a definition that has been live is archived rather than deleted, and asking to delete one is a 409.

Updates an in-app message definition. Only drafts are editable — lifecycle changes are explicit actions on the action route, never a field in this patch.

Moves an in-app message along its lifecycle. action is exactly one of set-live, pause, resume, end, archive or restore — those six values and nothing else; anything else is 404 unknown in-app action.

Duplicating a definition and sending a test exist in the product but are console-only, so POST …/duplicate and POST …/test are 404s here. A transition the message's current status does not allow is a 409.

The in-app message definitions eligible for one device at the start of a session — stable ids, placement, triggers, duration and redisplay rules, with either resolved structured blocks or an html_path to fetch. Capped at the active definitions the device qualifies for.

Called with the SDK key. On the shared sample app a bound device credential is required as well, and a subscription that is not this device's reads as a 404.