Mark an onboarding message seen, clicked or dismissed - Depict Documentation

Error

A valid request URL is required to generate request examples

{
  "id": 123,
  "event": "seen",
  "recorded": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

POST

/

onboarding-messages

/

{message_id}

Error

A valid request URL is required to generate request examples

{
  "id": 123,
  "event": "seen",
  "recorded": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Shopify App Bridge session token of the embedded Depict: Search & Merchandising app. The shop in the token determines the merchant; merchant_id parameters must belong to that shop.

Path Parameters

message_id

integer

required

The message id from the list.

Body

application/json

event

enum<string>

required

Available options:

seen,

clicked,

dismissed

Response

Whether this call recorded the event.

id

integer

required

event

enum<string>

required

Available options:

seen,

clicked,

dismissed

recorded

boolean

required

false when this event was already recorded for the message (each is set once).