In-app

List a contact's in-app messages

Changed on

Lists a contact's in-app messages and content cards, created by in_app sequence steps. With status open (default) it returns what the app should show now: messages not yet displayed, clicked or dismissed, and cards not dismissed, excluding expired items, messages first, then pinned cards, then newest. With status all it returns history, newest first. Identify the contact with email, externalId or subscriberId. Requires the subscribers:read scope.

get/in-app/messages

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/in-app/messages
  • Auth
    HTTP bearer

Query parameters

emailstring

Contact email (case-insensitive).

externalIdstring

Contact external ID.

subscriberIdstring
kind'message' | 'card'
status'open' | 'all'
limitinteger

Response

The contact's items

successboolean
subscriberIdstring
status'open' | 'all'

Example response

{
  "success": true
}

Changes

  • 54f67ac2d016Revision changes
    • warning

      added the new center enum value to the // response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • db3873ca3d4dRevision changes
    • info

      endpoint added