Mark guide as archived
Records that a guide has been archived by a user, triggering any associated archived events.
Mark guide as archived
Records that a guide has been archived by a user, triggering any associated archived events.
Endpoint
PUT/v1/users/{user_id}/guides/messages/{message_id}/archived
Rate limit
Tier 2Path parameters
user_id
string
The unique identifier of the user.
Request body
channel_id
string(uuid)
RequiredThe unique identifier for the channel.
content
object(any)
The content of the guide.
data
object(any)
The data of the guide.
guide_id
string(uuid)
RequiredThe unique identifier for the guide.
guide_key
string
RequiredThe key of the guide.
guide_step_ref
string
RequiredThe step reference of the guide.
is_final
boolean
Whether the guide is final.
metadata
object(any)
The metadata of the guide.
tenant
string
The tenant ID of the guide.
Returns
GuideActionResponse
A response for a guide action.
status
string
The status of a guide's action.