Guides
Users

Mark guide as archived

Changed on

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

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

Request

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

is_finalboolean

Whether the guide is final.

tenantstring

The tenant ID of the guide.

unthrottledboolean

Whether the guide bypasses its guide group's throttle settings. When true, archiving the guide does not open a new throttle window.

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",
  "is_final": false,
  "tenant": "ingen_isla_nublar",
  "unthrottled": false
}

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

    • info

      added the new optional request property

  • 136d5581336aRevision changes
    • warning

      deleted the path request parameter message_id