> ## Documentation Index
> Fetch the complete documentation index at: https://docs.depict.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Mark an onboarding message seen, clicked or dismissed

> Records one transition on a message from `onboardingMessages`. Each event is stored once (its first time); a repeat answers `recorded: false` and changes nothing. Side effect: a dismissed message stops being listed.



## OpenAPI

````yaml /api-reference/openapi/lite.json post /onboarding-messages/{message_id}
openapi: 3.1.0
info:
  title: Search & Merchandising API
  version: 1.0.0
  description: >-
    REST API behind Depict: Search & Merchandising, the native Shopify app:
    onboarding, collections, boost & bury, dashboards, A/B testing and
    multi-store management. Endpoints are served under the /api/lite prefix and
    are authenticated with the Shopify session token that App Bridge issues to
    the embedded app.
servers:
  - url: /api/lite
security:
  - ShopifySessionToken: []
paths:
  /onboarding-messages/{message_id}:
    post:
      summary: Mark an onboarding message seen, clicked or dismissed
      description: >-
        Records one transition on a message from `onboardingMessages`. Each
        event is stored once (its first time); a repeat answers `recorded:
        false` and changes nothing. Side effect: a dismissed message stops being
        listed.
      operationId: onboardingMessageEvent
      parameters:
        - schema:
            type: integer
            exclusiveMinimum: 0
            description: The message `id` from the list.
          required: true
          description: The message `id` from the list.
          name: message_id
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingMessageEventRequest'
      responses:
        '200':
          description: Whether this call recorded the event.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingMessageEventResponse'
        '400':
          description: The id is not a positive integer, or the body failed the schema.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '401':
          description: Not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '403':
          description: Authenticated, but this identity may not call the API.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '404':
          description: No such message for this caller.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '415':
          description: Content-Type is not application/json.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
        '500':
          description: Internal error.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Detail'
components:
  schemas:
    OnboardingMessageEventRequest:
      type: object
      properties:
        event:
          $ref: '#/components/schemas/OnboardingMessageEvent'
      required:
        - event
    OnboardingMessageEventResponse:
      type: object
      properties:
        id:
          type: integer
        event:
          $ref: '#/components/schemas/OnboardingMessageEvent'
        recorded:
          type: boolean
          description: >-
            false when this event was already recorded for the message (each is
            set once).
      required:
        - id
        - event
        - recorded
    Detail:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
      description: 'Every 4xx/5xx body: `{detail}`.'
    OnboardingMessageEvent:
      type: string
      enum:
        - seen
        - clicked
        - dismissed
  securitySchemes:
    ShopifySessionToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        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.

````