Guides
Users

Mark guide as interacted

Changed on

Records that a user has interacted with a guide, triggering any associated interacted events.

put/v1/users/{user_id}/guides/messages/interacted

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/users/{user_id}/guides/messages/interacted
  • 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.

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.

metadataobject

Metadata about the interaction.

tenantstring

The tenant ID of the guide.

Example request

{
  "channel_id": "123e4567-e89b-12d3-a456-426614174000",
  "guide_id": "7e9dc78c-b3b1-4127-a54e-71f1899b831a",
  "guide_key": "tour_notification",
  "guide_step_ref": "lab_tours",
  "metadata": {
    "cta": "Reserve Spot",
    "theme": "amber",
    "type": "banner"
  },
  "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

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

  • 136d5581336aRevision changes
    • info

      endpoint added