Skip to content
Search…
⌘K
Dashboard
API Reference
Get a product tour
Documentation
API Reference
Conversations API
Browse
Website
Helpcenter
Roadmap
Blog
Guides
API Overview
API Samples
Message templates
POST
Create a new message template.
GET
Find all message templates.
GET
List all message template tags.
GET
Find a message template.
PUT
Update a message template.
DEL
Delete a message template
Session
POST
Create a new session
GET
Get all sessions
PUT
Update a session
GET
Get a session
DEL
Delete a session
PUT
Resubscribe a session
GET
Search for sessions
21 more in Session
GET
Export sessions
POST
Pre-warm sessions cache for the active project
GET
Get a session by user id
GET
Get session activities
GET
Get session events
POST
Import sessions
POST
Import sessions from intercom
POST
Import sessions from HubSpot
POST
Import sessions from Zendesk
POST
Import sessions from Freshdesk
POST
Unsubscribe sessions
GET
Get session checklists
POST
Reset session checklist
GET
Get session identity history
GET
Get session Stripe info
GET
Get session Chargebee info
GET
Get session LemonSqueezy info
GET
Get session Shopify info
GET
Get session shop info
GET
Get session Shopify store panel
GET
FindSessionShopifyInfo
Team
POST
Create a new team
GET
Get all teams
GET
Get the boards' team setup
POST
Set the boards' team setup
PUT
Update a team
DEL
Delete a team
PUT
Reorder a team
Messages
POST
Create a new message
GET
Find messages by query
GET
Search messages
PUT
Update a message
DEL
Delete a message
POST
Create a thread reply
GET
Get thread messages
2 more in Messages
PUT
Set a message reaction
POST
Accept or decline an AI FAQ suggestion
Help center collections
POST
Create a new collection
GET
Get all collections
GET
Get all collections with subcollections
GET
Get article stats
PUT
Reorder collections
GET
Get a collection
PUT
Update a collection
2 more in Help center collections
DEL
Delete a collection
PUT
Publish or unpublish a collection's articles
Help center articles
POST
Create a new article
GET
Get all articles
PUT
Reorder articles
GET
Get an article
PUT
Update an article
DEL
Delete an article
GET
List article versions
8 more in Help center articles
POST
Create an article version checkpoint
GET
Get an article version
POST
Restore an article version
PUT
Move an article
GET
Get an article draft
PUT
Save an article draft
DEL
Discard an article draft
POST
Publish an article draft
Help center
GET
Search help center articles
GET
Get help center sources
GET
Answer help center question
Help center redirects
POST
Create a new redirect.
GET
Find all redirects.
PUT
Update a redirect.
DEL
Delete a redirect
Ticket
POST
Create a new ticket
GET
Get all tickets
POST
Create a new ticket with an optional initial message
GET
Search for tickets
GET
Extended ticket search (contacts + tickets)
GET
Find tickets by session query
GET
Export tickets as JSON
40 more in Ticket
GET
Get notification ticket
GET
Export tickets as CSV
GET
List available export fields
POST
Create a tracker ticket
GET
Find tracker tickets
GET
Search feature requests semantically
GET
Get a feature request's roadmap summary
POST
Generate tracker ticket data with AI
GET
Get ticket counts per status
GET
Export a single ticket for audit
GET
Get a ticket
PUT
Update a ticket
DEL
Delete a ticket
PUT
Merge multiple tickets into one
PUT
Bulk-update tickets
POST
Bulk-reply to tickets
GET
Get console logs for a ticket
GET
Get activity logs for a ticket
GET
Get the internal history of a ticket
GET
Get network logs for a ticket
GET
Get the session replay for a ticket
POST
Indicate user typing
POST
Indicate user viewing
GET
List current ticket viewers
PUT
Snooze a ticket
PUT
Set the composer draft message
DEL
Clear the composer draft message
PUT
Link a ticket to another ticket
PUT
Unlink a ticket
PUT
Archive a ticket
PUT
Mark a ticket as spam
PUT
Close a ticket as spam (agent verdict)
PUT
Archive all tickets in a lane
PUT
Unarchive a ticket
PUT
Await customer reply on a ticket
POST
Run workflow
POST
Send ticket to integration
POST
Vote for ticket
POST
Voice reply (dictate or smart)
POST
Send ticket conversation transcript to multiple emails
Engagement Banner
POST
Create a new banner
GET
Get all banners
PUT
Update a banner
DEL
Delete a banner
GET
Get a banner
Engagement Chat Message
POST
Create a new chat message
GET
Get all chat messages
PUT
Update a chat message
DEL
Delete a chat message
GET
Get a chat message
Engagement Cobrowse
POST
Create a new cobrowse product tour
GET
Get all cobrowse product tours
PUT
Update a cobrowse product tour
DEL
Delete a cobrowse product tour
GET
Get a cobrowse product tour
Engagement Email
POST
Create a new email
GET
Get all emails
PUT
Update an email
DEL
Delete an email
GET
Get an email
POST
Render an email preview
POST
Render the email editor canvas
5 more in Engagement Email
POST
Send email preview
POST
Preview Kai-written emails
GET
List Kai-written emails for review
POST
Approve or reject Kai-written emails in bulk
POST
Review a Kai-written email
Engagement News
POST
Create a new engagement news article
GET
Get all engagement news articles
GET
Get an engagement news article
PUT
Update a news article.
DEL
Delete a news article.
Engagement Product Tour
POST
Create a new product tour
GET
Get all product tours
PUT
Update a product tour
DEL
Delete a product tour
GET
Get a product tour
Engagement Push Notification
POST
Create a new push notification
GET
Get all push notifications
PUT
Update a push notification
DEL
Delete a push notification
GET
Get a push notification
Engagement Survey
POST
Create a new survey
GET
Get all surveys
PUT
Update a survey
DEL
Delete a survey
GET
Get a survey
GET
Preview a survey deletion
GET
Search survey responses
29 more in Engagement Survey
GET
Get all survey responses
GET
Export survey responses
PUT
Mark all survey responses as read
GET
Get survey response samples
GET
Summarize survey responses
POST
Validate a survey definition
POST
Validate a survey definition
PUT
Save a survey draft
POST
Edit a survey draft with Kai
POST
Publish a survey
GET
List survey versions
GET
Get a survey version
PUT
Save survey page settings
POST
Create personal survey links
GET
Get survey stats
GET
Get survey respondent paths
GET
Get survey analytics
GET
Get survey insights
POST
Link an item to a survey theme
DEL
Unlink an item from a survey theme
POST
Refresh survey insights
POST
Ask about survey results
PUT
Edit survey themes
GET
Get a survey response
DEL
Delete a survey response
POST
Reach out to a respondent
POST
Migrate a legacy survey
GET
Survey email recipients
GET
Survey email campaigns
Engagement Tooltip
POST
Create a new tooltip
GET
Get all tooltips
PUT
Update a tooltip
DEL
Delete a tooltip
GET
Get a tooltip
Engagement Whatsapp Messages
POST
Create a new whatsapp message
GET
Get all WhatsApp messages
PUT
Update a whatsapp message
DEL
Delete a whatsapp message
GET
Get a whatsapp message
POST
Send a whatsapp template message
Engagement Checklist
POST
Create a new checklist
GET
Get all checklists
PUT
Update a checklist
DEL
Delete a checklist
GET
Get a checklist
Engagement
GET
Get engagement activities
GET
Get engagement activities count
GET
Find engagement recipients
GET
Export engagement recipients
GET
Get engagement statistics
POST
Get engagement fixed audience samples
POST
Clone engagement
AI content
POST
Create AI content
GET
Get AI content by contentId
PUT
Update AI content by contentId
DEL
Delete AI content by contentId
DEL
Delete old AI content batches
DEL
Delete AI content by batchId
POST
Import YouTube video
6 more in AI content
GET
List YouTube content
POST
Preview YouTube URL
GET
YouTube allowance
POST
Import YouTube playlist/channel
DEL
Delete YouTube video content
DEL
Delete YouTube batch content
Engagement Modal
POST
Create a new modal
GET
Get all modals
PUT
Update a modal
DEL
Delete a modal
GET
Get a modal
Invitation
GET
Get all invitations for a user
DEL
Delete an invitation
PUT
Accept or decline an invitation
PUT
Update an invitation's role
GET
Get all invitations for an organisation
POST
Invite people to an organisation
GET
Get all invitations for a project
2 more in Invitation
POST
Invite people to a project
PUT
Update an invitation's board-only access
Project
GET
Get all users for a project
PUT
Update a project member's role
DEL
Remove a member from a project
PUT
Set a member's board-only access
User
GET
Get current user.
POST
Hand over the user's open tickets to their team
GET
Get unified inbox tickets
GET
Get unified inbox ticket
PUT
Update the current user
GET
Get current user's role permissions.
POST
Sign up a new user
4 more in User
POST
Verify a user's email address
POST
Resend a verification code to the user's email.
POST
Authenticate a session for websockets
POST
Authorize a session channel subscription
Statistics
GET
GetReportScope
GET
GetChartData
GET
GetFactData
GET
GetListData
GET
ExportListData
GET
GetHeatmapData
GET
GetEmailOverviewStats
3 more in Statistics
GET
GetEmailClientUsageStats
GET
GetEmailClientBouncesStats
GET
GetRawStatistics
Knowledge
POST
Search knowledge documents
POST
Find similar tickets
GET
Get content tags in use
Translations
GET
List all translatable entries
GET
Get a single translatable entry
PUT
Update a translatable entry
AiModels
GET
Get AI model catalog
Code
POST
Ask a question about the project's connected source repositories
ContactMemory
GET
List contact memory entries
POST
Create or update a contact memory entry
DEL
Clear all contact memory entries
GET
Get one contact memory entry
PUT
Update a contact memory entry
DEL
Delete a contact memory entry
Engagement Editor
POST
Check whether the visual editor will work on a URL
FrontendTools
POST
Deliver a frontend tool execution result.
Company
GET
List companies
GET
Count companies
GET
Search companies
POST
Import companies
GET
Get a company
PUT
Create or update a company
DEL
Delete a company
4 more in Company
GET
Get company members
POST
Add a company member
GET
Get company conversations
DEL
Remove a company member
Uploads
POST
Upload a file
POST
Import an image from a URL
POST
Create an image upload link
Pipelines
GET
List pipelines
GET
Get a pipeline
GET
List pipeline fields
GET
List entries of a stage
POST
Add a record to a pipeline
Pipeline entries
PUT
Move an entry
PUT
Update entry values
PUT
Update record values through an entry
PUT
Set an entry's due date
DEL
Remove an entry
GET
Get an entry
AgentEvals
POST
CreateExample
Records
GET
Conversation counts for a record
GET
What is coming up on a record
GET
Conversations waiting on us
GET
Record summary
POST
Refresh a record summary
S2S Contacts
PUT
Upsert contact
GET
Get contact
DEL
Delete contact
POST
Track contact events
POST
Create conversation
GET
List contact conversations
S2S Conversations
GET
Get conversation
PATCH
Update conversation
POST
Close conversation
POST
Reopen conversation
POST
Mark conversation read
POST
Typing indicator
PUT
Set network logs
7 more in S2S Conversations
PUT
Set conversation events
POST
Rate conversation
POST
Send message
GET
List messages
GET
Get pending workflow step
POST
Answer workflow step
POST
Run workflow
S2S Messages
GET
Get message
POST
Rate message
S2S Stream
GET
Get stream config
POST
Authorize channel subscription
POST
Authenticate stream user
S2S Webhooks
GET
List webhooks
POST
Create webhook
DEL
Delete webhook
S2S Workflows
GET
List workflows
Ticket types
GET
List boards
POST
Create a board
PUT
Reorder boards
PUT
Update a board
DEL
Delete a board
Settings
GET
List settings pages
GET
Get settings
PUT
Update settings
AI provenance
POST
Was this written by Gleap's AI?
Onboarding
POST
Claim
GET
Status
Collections
Documentation
Get Started
Introduction
SDKs
JavaScript
Introduction
Code snippet
User identity
Callbacks
AI chatbar
Frontend tools
Replays
Forms
Feedback button
Push notifications
In-app notifications
Audio recording
Screenshots and recordings
Console logs
Custom actions
Ticket attributes
Custom data
Environment data
Track pages
Track events
Tags
Custom URL handler
Network logs
Dark mode
Translations
Widget control
Prefill the widget form
Privacy controls
Cookies
Environment
Content Security Policy (CSP)
Rendering issues
Widget apps
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
Product tours
UI components
Checklist UI component
AI Agent UI component
iOS
Introducing
User identity
Callbacks
Frontend tools
Forms
Feedback button
Activation methods
Push notifications
In-app notifications
Audio recording
Screenshots and recordings
Console logs
Custom actions
Ticket attributes
Custom data
Attachments
Environment data
Track events
Track pages
Tags
Custom URL handler
Network logs
Dark mode
Translations
Widget control
Prefill the widget form
Widget apps
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
Android
Introducing
User identity
Callbacks
Frontend tools
Forms
Feedback button
Activation methods
Push notifications
In-app notifications
Audio recording
Screenshots and recordings
Console logs
Custom actions
Ticket attributes
Custom data
Attachments
Environment data
Track events
Track pages
Tags
Custom URL handler
Network logs
Dark mode
Translations
Widget control
Prefill the widget form
Troubleshooting
Widget apps
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
React Native
Introducing
User identity
Track events
Track pages
Frontend tools
Forms
Push notifications
In-app notifications
Audio recording
Screenshots and recordings
Console logs
Custom actions
Ticket attributes
Custom data
Attachments
Environment data
Callbacks
Tags
Feedback button
Activation methods
Network logs
Dark mode
Translations
Widget control
Prefill the widget form
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
React Native Expo Guide
Flutter
Introducing
User identity
Track events
Track pages
Frontend tools
Forms
Push notifications
In-app notifications
Audio recording
Screenshots and recordings
Console logs
Custom actions
Ticket attributes
Custom data
Attachments
Environment data
Callbacks
Tags
Feedback button
Activation methods
Network logs
Dark mode
Translations
Widget control
Prefill the widget form
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
FlutterFlow
Introducing
Ionic / Capacitor
Introducing
User identity
Frontend tools
Track events
Track pages
Forms
Push notifications
In-app notifications
Audio recording
Screenshots and recordings
Console logs
Custom actions
Ticket attributes
Custom data
Environment data
Callbacks
Tags
Feedback button
Network logs
Dark mode
Translations
Widget control
Prefill the widget form
Suppressing personal data
Content Security Policy (CSP)
Rendering issues
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
Cordova
Introducing
User identity
Track events
Track pages
Forms
Audio recording
Console logs
Custom data
Tags
Feedback button
Network logs
Translations
Widget control
Prefill the widget form
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
In-app notifications
Windows Desktop (Beta)
Introducing (Beta)
User identity
Track events
Track pages
Forms
Frontend tools
Console logs
Custom actions
Ticket attributes
Custom data
Callbacks
Tags
Feedback button
Network logs
Translations
Widget control
Prefill the widget form
Attachments
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
.NET MAUI (Beta)
Introducing (Beta)
User identity
Track events
Track pages
Forms
Frontend tools
Console logs
Custom actions
Ticket attributes
Custom data
Callbacks
Tags
Feedback button
Network logs
Translations
Widget control
Prefill the widget form
Attachments
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
Unity (Beta)
Introducing (Beta)
User identity
Track events
Track pages
Forms
Frontend tools
Console logs
Custom actions
Ticket attributes
Custom data
Callbacks
Tags
Feedback button
Network logs
Translations
Widget control
Prefill the widget form
Attachments
Conversations
Feature requests
Help center
Release notes & news
Surveys
Checklists
Kai Code
Kai Code
Getting started
Sessions
Tickets and pull requests
Claude Code, Codex and others
Repositories
Lovable, Replit, v0 and Base44
MCP servers
Customer replies
Kai Code Bridge
Local models
Surveys
Overview
Survey definition
Analytics
REST API
Webhooks
Automations
MCP tools
Sequences
MCP tools
Server-side event tracking
NodeJS
REST
Guides
Enforce identity verification
Authenticated conversation files
Data regions
Connect the Gleap MCP
Plans and AI pricing
Screenshots, recordings and logs
Your shop API
Conversations API
Engagement Product Tour
Copy page
Copy page as Markdown
For pasting into ChatGPT, Claude or your editor
View as Markdown
Plain text of this article (.md)
Open in ChatGPT
Ask questions about this page
Open in Claude
Ask questions about this page
Open in Perplexity
Ask questions about this page
Add to Cursor
Connect this help center as an MCP server
Get a product tour
Get an engagement product tour
GET
https://api.gleap.io/v3
/engagement/product-tours/
{productTourId}
Try it
Authorizations
Authorization
string · header
required
Bearer authentication header of the form
Bearer <token>
.
Path parameters
productTourId
string
required
Headers
project
string
required
Response
200
application/json
Ok
Updated November 1, 2026
← Previous
Delete a product tour
Next →
Create a new push notification
Try it
