Guides
Users

Reset guide engagement

Changed on

Resets the engagement state of a guide for a user, removing the guide's engagement log entry so the next interaction creates a fresh engagement.

put/v1/users/{user_id}/guides/engagements/reset

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/users/{user_id}/guides/engagements/reset
  • Auth: HTTP bearer

Path parameters

user_idstring required

The unique identifier of the user.

Request body

guide_keystring required

The key of the guide.

tenantstring

The tenant ID of the guide.

Example request

{
  "guide_key": "tour_notification",
  "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

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

  • 3e8f3a4664d4Revision changes
    • info

      endpoint added