Guides
Users

Mark guide as seen

Changed on

Records that a guide has been seen by a user, triggering any associated seen events.

put/v1/users/{user_id}/guides/messages/{message_id}/seen

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/users/{user_id}/guides/messages/{message_id}/seen
  • Auth: HTTP bearer

Path parameters

user_idstring required

The unique identifier of the user.

Request body

channel_idstring uuid required

The unique identifier for the channel.

contentobject required

The content of the guide.

dataobject

The data of the guide.

guide_idstring uuid required

The unique identifier for the guide.

guide_keystring required

The key of the guide.

guide_step_refstring required

The step reference of the guide.

tenantstring

The tenant ID of the guide.

Example request

{
  "channel_id": "123e4567-e89b-12d3-a456-426614174000",
  "content": {
    "body": "Limited spots available for today's behind-the-scenes DNA extraction demonstration.",
    "title": "DNA Lab Tour Available"
  },
  "data": {
    "next_time": "14:30",
    "spots_left": 8,
    "tour_id": "dna_lab_tour"
  },
  "guide_id": "7e9dc78c-b3b1-4127-a54e-71f1899b831a",
  "guide_key": "tour_notification",
  "guide_step_ref": "lab_tours",
  "tenant": "ingen_isla_nublar"
}

Response

OK

statusstring required

The status of a guide's action.

Example response

{
  "status": "ok"
}

Changes

  • 512ce7e55eb6Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became required

    • warning

      removed the request property

    • warning

      removed the request property

  • 136d5581336aRevision changes
    • warning

      deleted the path request parameter message_id