v30

latestOpenAPI 3.0.0raw.githubusercontent.com2026-04-22116135580.0 KB

Guides

Users

Mark guide as unarchived

Records that a guide has been unarchived, triggering any associated unarchived events.

delete/v1/users/{user_id}/guides/messages/archived

Path parameters

user_idstring required

The unique identifier of the user.

Request body

channel_idstring uuid required

The unique identifier for the channel.

contentobject

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.

is_finalboolean

Whether the guide is final.

metadataobject

The metadata of the guide.

tenantstring nullable

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",
  "is_final": false,
  "metadata": {
    "cta": "Reserve Spot",
    "theme": "amber",
    "type": "banner"
  },
  "tenant": "ingen_isla_nublar"
}

Response

statusstring required

The status of a guide's action.

Example response

{
  "status": "ok"
}