# Gleap

Gleap is an all-in-one customer feedback tool for apps and websites, enabling direct communication with users to build better software by discovering their everyday pain points.

- **Category:** customer support
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 179
- **Triggers:** 0
- **Slug:** `GLEAP`
- **Version:** 20260312_00

## Tools

### Archive All Tickets

**Slug:** `GLEAP_ARCHIVE_ALL_TICKETS`

Tool to archive all tickets matching specific type and status criteria. Use when you need to bulk archive multiple tickets at once based on their type and status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | The ticket type to filter by. Common values include 'bug', 'feature', 'feedback', etc. Required to specify which ticket type to archive. |
| `status` | string | Yes | The ticket status to filter by. Common values include 'open', 'closed', 'pending', etc. Required to specify which status to archive. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Archive a Ticket

**Slug:** `GLEAP_ARCHIVE_A_TICKET`

Tool to archive a ticket. Use after confirming the ticket ID and that the ticket is resolved. Call when moving tickets to history.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticketId` | string | Yes | Identifier of the ticket to archive |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Clone Engagement

**Slug:** `GLEAP_CLONE_ENGAGEMENT`

Tool to clone an existing engagement. Use when you need to duplicate an engagement with all its configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `engagementId` | string | Yes | The unique identifier (ObjectId) of the engagement to clone. Must be a valid engagement ID from the project's engagements list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a Collection

**Slug:** `GLEAP_CREATE_A_COLLECTION`

Tool to create a help center collection. Use when adding a new organizational grouping in your Help Center.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `docId` | integer | No | Numeric document ID this collection belongs to, if applicable |
| `title` | string | Yes | Title of the help center collection |
| `parent` | string | No | Identifier of the parent collection for nesting |
| `iconUrl` | string | No | URL to an icon representing the collection |
| `lexorank` | string | No | String used to order this collection among its peers |
| `externalId` | string | No | External identifier for syncing with other systems |
| `description` | string | No | Detailed description of the collection |
| `targetAudience` | string | No | Audience for this collection, defaults to 'all' |
| `baseAudienceFilter` | object | No | Base filter criteria object to limit the audience |
| `extendedAudienceFilter` | object | No | Additional filter criteria to extend the base audience |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create AI Content

**Slug:** `GLEAP_CREATE_AI_CONTENT`

Tool to create or update AI content in Gleap's knowledge base. Use when adding new documentation, help articles, or product information that AI assistants can reference. Supports text, file, and product content types with optional batch operations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("text" | "file" | "product") | Yes | Type of content being created. Must be one of: 'text' (text-based content), 'file' (file-based content), or 'product' (product information). |
| `title` | string | Yes | Title of the AI content (required) |
| `batchId` | string | No | Optional batch identifier for grouping multiple content items together. Useful for bulk operations. |
| `content` | object | Yes | Content object containing the actual content data. For text type, use {'text': 'Your content here'}. Structure varies by content type. |
| `contentId` | string | Yes | Unique identifier for this content item. Use this ID to update existing content or create new content with a specific ID. |
| `readMoreUrl` | string | No | URL where users can access the full content or additional information. |
| `readMoreLabel` | string | No | Label text for the 'read more' link (e.g., 'Learn More', 'View Full Article'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new chat message

**Slug:** `GLEAP_CREATE_A_NEW_CHAT_MESSAGE`

Creates a new chat message in a Gleap chat session. Use this action to: - Send a message as a user or admin in an existing chat session - Reply to customer inquiries in the Gleap support system - Add messages to ongoing conversations The action requires a valid sessionId (obtained from get_all_sessions or get_all_chat_messages actions), a role ("user" or "admin"), and message content. Returns the created message with its ID, timestamps, and configuration details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("user" | "admin") | Yes | Role of the message sender. Use "user" for customer messages or "admin" for support team responses. |
| `content` | string | Yes | Text content of the chat message. Supports unicode characters, emojis, newlines, and special characters. |
| `sessionId` | string | Yes | Unique identifier of the chat session where the message will be created. Must be a valid session ID from the Gleap project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new session

**Slug:** `GLEAP_CREATE_A_NEW_SESSION`

Create a new user session in Gleap and associate it with a project. Use this to track user activity, engagement metrics, and session data. Sessions can be created with minimal information and enriched later through identify_user or other API calls.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sla` | number | No | Service level agreement value or response time in hours |
| `lang` | string | No | User's preferred language code (ISO 639-1 format, e.g., 'en', 'de', 'fr') |
| `name` | string | No | User's full name |
| `plan` | string | No | User's subscription plan or tier (e.g., 'free', 'pro', 'enterprise') |
| `tags` | array | No | List of tags for categorizing and filtering sessions |
| `email` | string | No | User's email address for session identification and communication |
| `phone` | string | No | User's phone number |
| `value` | number | No | Monetary or lifetime value associated with the user |
| `avatar` | string | No | URL or path to the user's avatar image |
| `userId` | string | No | Unique user identifier from your system. Used to track sessions across different devices and platforms |
| `blocked` | boolean | No | Whether the user is blocked from creating feedback or support tickets |
| `gleapId` | string | No | Unique Gleap session identifier (auto-generated if not provided) |
| `project` | string | No | Project ID to associate the session with. If not provided, uses the project from authentication headers |
| `platform` | string | No | Platform or operating system (e.g., 'iOS', 'Android', 'Windows', 'macOS') |
| `sessions` | number | No | Total number of sessions for this user |
| `companyId` | string | No | Unique identifier of the company the user belongs to |
| `emailOnly` | boolean | No | If true, indicates the user should only be contacted via email |
| `gleapHash` | string | No | Security hash for verifying user identity in secure mode |
| `customData` | object | No | Custom metadata as key-value pairs for storing additional session-specific data (e.g., {'app_version': '2.0.1', 'platform': 'web'}) |
| `deviceType` | string | No | Type of device (e.g., 'desktop', 'mobile', 'tablet') |
| `companyName` | string | No | Name of the company the user belongs to |
| `organisation` | string | No | Organisation identifier the session belongs to |
| `unsubscribed` | boolean | No | Whether the user has unsubscribed from communications |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new team

**Slug:** `GLEAP_CREATE_A_NEW_TEAM`

Tool to create a new team. Use when you have team details ready and want to assign tickets among members.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the team to create |
| `members` | array | Yes | List of user IDs to include in the team |
| `assignmentMethod` | string ("random" | "balanced" | "manual" | "circular") | Yes | Method used to assign tickets within the team. 'random' assigns tickets randomly, 'balanced' distributes evenly across members, 'manual' requires manual assignment, and 'circular' rotates through members in order |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a new ticket

**Slug:** `GLEAP_CREATE_A_NEW_TICKET`

Create a new support ticket in Gleap with detailed information including title, description, type, priority, status, tags, and attachments. Supports custom metadata and sentiment tracking for comprehensive ticket management and customer feedback analysis.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags for categorizing and organizing tickets |
| `type` | string | No | Ticket type/category (e.g., 'BUG', 'FEATURE_REQUEST', 'QUESTION', 'FEEDBACK') |
| `title` | string | Yes | Ticket title (required) |
| `status` | string | No | Ticket status (e.g., 'OPEN', 'IN_PROGRESS', 'RESOLVED', 'CLOSED'). Defaults to 'OPEN' if not specified |
| `dueDate` | string | No | Due date for ticket resolution in ISO 8601 format (e.g., '2026-02-15T10:00:00Z') |
| `priority` | string | No | Priority level: 'LOW', 'MEDIUM', or 'HIGH'. Helps prioritize ticket handling |
| `sentiment` | string | No | User sentiment: 'positive', 'negative', or 'neutral'. Helps gauge customer satisfaction |
| `customData` | object | No | Custom metadata as key-value pairs (e.g., {'browser': 'Chrome', 'version': '120.0'}) |
| `attachments` | array | No | List of file attachments with name, URL, and MIME type |
| `description` | string | No | Detailed description of the ticket issue or request |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Banner

**Slug:** `GLEAP_CREATE_ENGAGEMENT_BANNER`

Tool to create a new engagement banner in Gleap. Use when you want to add a banner for user engagement, announcements, or surveys. All fields are optional; the API will create a banner with default values if no fields are specified (default name: 'New survey', status: 'draft', format: 'widget', frequency: 'once').

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the banner. Defaults to 'New survey' if not specified |
| `pages` | array | No | List of specific pages where the banner should appear |
| `format` | string | No | Display format for the banner. Defaults to 'widget' if not specified |
| `status` | string | No | Banner status: 'draft' or 'active'. Defaults to 'draft' if not specified |
| `content` | object | No | Banner content configuration including text, images, buttons, etc. |
| `frequency` | string | No | Frequency at which the banner is shown: 'once', 'always', 'daily', etc. Defaults to 'once' if not specified |
| `pageFilterType` | string | No | Type of page filtering to apply: 'all', 'specific', 'exclude', etc. |
| `targetAudience` | string | No | Target audience for the banner: 'all', 'specific', etc. Determines who can see the banner |
| `baseAudienceFilter` | object | No | Base filter criteria to limit the audience who sees this banner |
| `extendedAudienceFilter` | object | No | Additional filter criteria to extend the base audience targeting |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Checklist

**Slug:** `GLEAP_CREATE_ENGAGEMENT_CHECKLIST`

Tool to create a new engagement checklist. Use when you need to set up a step-by-step guide or task list for users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the checklist |
| `steps` | array | No | List of steps to include in the checklist. Each step can have a title and optional description |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Cobrowse

**Slug:** `GLEAP_CREATE_ENGAGEMENT_COBROWSE`

Tool to create a new cobrowse product tour. Use when you need to set up an interactive guided tour for users to follow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the cobrowse product tour |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Email

**Slug:** `GLEAP_CREATE_ENGAGEMENT_EMAIL`

Tool to create a new engagement email in Gleap. Use when you want to send emails for user engagement, announcements, or marketing campaigns. Requires name, subject, and body; other fields are optional with defaults (type: 'EMAIL', status: 'draft', format: 'widget', frequency: 'once', targetAudience: 'all').

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Email body content (can include HTML) |
| `name` | string | Yes | Name of the engagement email |
| `type` | string | No | Type of engagement element. Defaults to 'EMAIL' if not specified |
| `format` | string | No | Display format for the email. Defaults to 'widget' if not specified |
| `status` | string | No | Email status: 'draft' or 'active'. Defaults to 'draft' if not specified |
| `subject` | string | Yes | Email subject line |
| `frequency` | string | No | Frequency at which the email is sent: 'once', 'always', 'daily', etc. Defaults to 'once' if not specified |
| `targetAudience` | string | No | Target audience for the email: 'all', 'specific', etc. Determines who receives the email. Defaults to 'all' if not specified |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Modal

**Slug:** `GLEAP_CREATE_ENGAGEMENT_MODAL`

Tool to create a new engagement modal in Gleap. Use when you want to display a modal dialog for user engagement, onboarding, announcements, or feature introductions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the modal (required) |
| `type` | string | No | Type of engagement element (auto-populated as MODAL by the server) |
| `sound` | boolean | No | Whether to play a sound when the modal appears |
| `format` | string | No | Display format for the modal. Defaults to 'widget' if not specified |
| `hidden` | boolean | No | Whether the modal is hidden from users |
| `status` | string | No | Modal status: 'DRAFT' or 'ACTIVE'. Defaults to 'DRAFT' if not specified |
| `frequency` | string | No | Frequency at which the modal is shown: 'once', 'always', 'daily', etc. Defaults to 'once' if not specified |
| `frequencyType` | string | No | Type of frequency control: 'dynamic', 'static', etc. Defaults to 'dynamic' if not specified |
| `targetAudience` | string | No | Target audience for the modal: 'all', 'specific', etc. Determines who can see the modal. Defaults to 'all' if not specified |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Product Tour

**Slug:** `GLEAP_CREATE_ENGAGEMENT_PRODUCT_TOUR`

Tool to create a new product tour in Gleap. Use when you want to create guided tours for onboarding, feature introductions, or step-by-step walkthroughs for users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the product tour (required) |
| `type` | string | No | Type of engagement element. Defaults to 'TOUR' if not specified |
| `active` | boolean | No | Whether the product tour is active. Defaults to false if not specified |
| `format` | string | No | Display format for the tour. Defaults to 'widget' if not specified |
| `status` | string | No | Status of the tour: 'draft' or 'active'. Defaults to 'draft' if not specified |
| `frequency` | string | No | Frequency at which the tour is shown: 'once', 'always', 'daily', etc. Defaults to 'once' if not specified |
| `targetAudience` | string | No | Target audience for the tour: 'all', 'specific', etc. Determines who can see the tour. Defaults to 'all' if not specified |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Push Notification

**Slug:** `GLEAP_CREATE_ENGAGEMENT_PUSH_NOTIFICATION`

Tool to create a new push notification in Gleap. Use when you want to send push notifications for user engagement, announcements, or alerts. All fields are optional; the API will create a notification with default values (name: 'New survey', type: 'PUSH', status: 'draft', sound: true, hidden: false, sent: false, format: 'widget', frequencyType: 'dynamic', frequency: 'once', frequencyDays: 0).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the push notification. Defaults to 'New survey' if not specified |
| `sent` | boolean | No | Whether the notification has been sent to users. Defaults to false if not specified |
| `type` | string | No | Type of engagement element. Defaults to 'PUSH' if not specified |
| `sound` | boolean | No | Whether to play a notification sound. Defaults to true if not specified |
| `format` | string | No | Display format for the notification. Defaults to 'widget' if not specified |
| `hidden` | boolean | No | Whether the notification is hidden from users. Defaults to false if not specified |
| `status` | string | No | Notification status: 'draft' or 'active'. Defaults to 'draft' if not specified |
| `frequency` | string | No | Frequency at which the notification is shown: 'once', 'always', 'daily', etc. Defaults to 'once' if not specified |
| `newTrigger` | boolean | No | Whether this is a new trigger for the notification |
| `frequencyDays` | integer | No | Number of days for frequency calculation. Defaults to 0 if not specified |
| `frequencyType` | string | No | Type of frequency calculation: 'dynamic', 'daily', 'weekly', etc. Defaults to 'dynamic' if not specified |
| `pageFilterType` | string | No | Type of page filtering to apply: 'all', 'specific', 'exclude', etc. |
| `targetAudience` | string | No | Target audience for the notification: 'all', 'specific', etc. Determines who receives the notification |
| `stopSendingAfter` | string | No | ISO 8601 timestamp when to stop sending the notification (e.g., '2026-12-31T23:59:59Z') |
| `startSendingAfter` | string | No | ISO 8601 timestamp when to start sending the notification (e.g., '2026-02-14T10:00:00Z') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Tooltip

**Slug:** `GLEAP_CREATE_ENGAGEMENT_TOOLTIP`

Tool to create a new engagement tooltip in Gleap. Use when you want to add tooltips for user guidance, onboarding, or feature explanations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the tooltip |
| `content` | string | Yes | Content/text of the tooltip |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create feedback item

**Slug:** `GLEAP_CREATE_FEEDBACK_ITEM`

Tool to manually create a feedback item (bug) in a Gleap project. Use when you need to: - Create a new bug report programmatically - Add customer feedback to a specific project - Submit feature requests or issues via API Requires project ID, title, and description. Supports optional fields like type, priority, status, tags, and custom metadata for comprehensive feedback tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The project ID where the feedback item will be created. This is a 24-character hexadecimal string. |
| `tags` | array | No | Tags for categorizing and organizing feedback items |
| `type` | string | No | Type of feedback item (e.g., 'BUG', 'FEATURE_REQUEST', 'QUESTION', 'FEEDBACK') |
| `title` | string | Yes | The title/subject of the bug or feedback item (required) |
| `status` | string | No | Status of the feedback item (e.g., 'OPEN', 'IN_PROGRESS', 'RESOLVED', 'CLOSED') |
| `priority` | string | No | Priority level: 'LOW', 'MEDIUM', or 'HIGH' |
| `customData` | object | No | Custom metadata as key-value pairs |
| `description` | string | Yes | Detailed description of the bug or feedback (required) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Help Center Redirect

**Slug:** `GLEAP_CREATE_HELPCENTER_REDIRECT`

Tool to create a new redirect for help center URLs. Use when you need to redirect old or deprecated help articles to new URLs. Supports both exact URL matching and pattern-based matching for flexible redirect rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `newUrl` | string | Yes | The new URL path to redirect to (e.g., '/new-help-article') |
| `oldUrl` | string | Yes | The old URL path to redirect from (e.g., '/old-help-article') |
| `matchType` | string ("exact" | "pattern") | Yes | Match type for the redirect: 'exact' for exact URL match or 'pattern' for pattern-based matching |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Message Template

**Slug:** `GLEAP_CREATE_MESSAGE_TEMPLATE`

Tool to create a new message template in Gleap. Use when creating pre-defined message templates for support conversations, automated responses, or quick replies. The template can include actions (buttons, links) and attachments, and can be shared publicly or restricted to specific users.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Title of the message template |
| `users` | array | No | List of user IDs who can access this message template. Only applicable if isPublic is false. |
| `actions` | array | No | List of actions associated with the message template (e.g., buttons, links) |
| `content` | object | Yes | Content of the message template. Contains text and formatting data as a dictionary. |
| `isPublic` | boolean | No | Whether the message template is publicly accessible. Defaults to false if not specified. |
| `lexorank` | string | Yes | String used to order this template among its peers. Used for sorting and positioning. |
| `attachments` | array | No | List of file attachments for the message template |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create new conversation with session

**Slug:** `GLEAP_CREATE_NEW_CONVERSATION`

Create a new conversation with a session in Gleap. Use this action to initiate a conversation linked to a specific session ID within a project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sessionId` | string | Yes | Session ID to associate with the conversation. Must be a valid session ID from the Gleap project. |
| `project_id` | string | Yes | Project ID where the conversation will be created. This is the unique identifier of the Gleap project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create QA Snippet

**Slug:** `GLEAP_CREATE_QA_SNIPPET`

Tool to create a QA snippet (question-answer pair) in Gleap. Use when you need to add knowledge base content or FAQ entries to help AI assistants answer user questions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `answer` | string | Yes | The answer text for the QA snippet |
| `question` | string | Yes | The question text for the QA snippet |
| `project_id` | string | Yes | The project ID to create the QA snippet in |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Tracker Ticket

**Slug:** `GLEAP_CREATE_TRACKER_TICKET`

Tool to create a tracker ticket in Gleap. Use when you need to create a new tracker-based ticket for tracking features, bugs, or tasks.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Type classification of the tracker ticket (e.g., 'bug', 'feature', 'task') |
| `title` | string | No | Title of the tracker ticket |
| `description` | string | No | Detailed description of the tracker ticket |
| `linkedTicketIds` | array | No | Array of ticket IDs to link to this tracker ticket |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete AI Content

**Slug:** `GLEAP_DELETE_AI_CONTENT`

Tool to delete AI content by content ID. Use when you need to remove specific AI content from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contentId` | string | Yes | The unique identifier of the AI content to delete. This is the content ID string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete AI Content Batch

**Slug:** `GLEAP_DELETE_AICONTENT_BATCH`

Tool to delete all AI content by batchId. Use when you need to remove all AI-generated content associated with a specific batch identifier.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batchId` | string | Yes | The unique batch identifier of the AI content to delete. All AI content items associated with this batch will be removed. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete a User from a Project

**Slug:** `GLEAP_DELETE_A_USER_FROM_A_PROJECT`

Removes a user (team member) from a Gleap project, revoking their access. Use this when you need to remove a team member's access to the project by their user ID. The user ID can be obtained from the 'Get All Users for a Project' action. Note: This removes organization members from the project, not end-user sessions/contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | The unique identifier (ObjectId) of the user to remove from the project. Must be a valid user ID from the project's user list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Bugs

**Slug:** `GLEAP_DELETE_BUGS`

Tool to delete a bug/ticket by ID. Use when you need to permanently remove a bug from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the bug/ticket to delete. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Banner

**Slug:** `GLEAP_DELETE_ENGAGEMENT_BANNER`

Tool to delete an engagement banner. Use when you need to remove a banner from the project by its banner ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bannerId` | string | Yes | The unique identifier (ObjectId) of the banner to delete. Must be a valid banner ID from the project's engagement banners list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Chat Message

**Slug:** `GLEAP_DELETE_ENGAGEMENT_CHAT_MESSAGE`

Deletes an engagement chat message from Gleap by its ID. Use this action to permanently remove a chat message from a conversation. The message ID must be obtained from a prior list or get operation. Once deleted, the message cannot be recovered.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chatMessageId` | string | Yes | The unique identifier (MongoDB ObjectId) of the chat message to delete. Must be a valid 24-character hex string representing an existing message. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Checklist

**Slug:** `GLEAP_DELETE_ENGAGEMENT_CHECKLIST`

Tool to delete an engagement checklist by its ID. Use when removing a checklist from the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `checklistId` | string | Yes | Unique identifier of the checklist to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Cobrowse

**Slug:** `GLEAP_DELETE_ENGAGEMENT_COBROWSE`

Tool to delete a cobrowse product tour by its ID. Use when you need to remove a cobrowse product tour from the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cobrowseProductTourId` | string | Yes | The unique identifier of the cobrowse product tour to delete. Must be a valid ObjectId (24-character hexadecimal string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Email

**Slug:** `GLEAP_DELETE_ENGAGEMENT_EMAIL`

Tool to delete an engagement email by its ID. Use when you need to remove an email from the project's engagement emails list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `engagementEmailId` | string | Yes | The unique identifier (ObjectId) of the engagement email to delete. Must be a valid email ID from the project's engagement emails list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Modal

**Slug:** `GLEAP_DELETE_ENGAGEMENT_MODAL`

Tool to delete an engagement modal from a Gleap project. Use when you need to remove a modal by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modal_id` | string | Yes | The unique identifier of the engagement modal to delete. Must be a valid modal ID (24-character hexadecimal ObjectId). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement News

**Slug:** `GLEAP_DELETE_ENGAGEMENT_NEWS`

Tool to delete an engagement news article. Use when you need to remove a news article from the project by its news ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `newsId` | string | Yes | The unique identifier (ObjectId) of the news article to delete. Must be a valid news ID from the project's engagement news list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Product Tour

**Slug:** `GLEAP_DELETE_ENGAGEMENT_PRODUCT_TOUR`

Tool to delete an engagement product tour by its ID. Use when you need to remove a product tour from the project's engagement product tours list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `productTourId` | string | Yes | The unique identifier (ObjectId) of the product tour to delete. Must be a valid product tour ID from the project's engagement product tours list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Push Notification

**Slug:** `GLEAP_DELETE_ENGAGEMENT_PUSH_NOTIFICATION`

Tool to delete an engagement push notification by its ID. Use when you need to remove a push notification from the project's engagement push notifications list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pushNotificationId` | string | Yes | The unique identifier (ObjectId) of the push notification to delete. Must be a valid push notification ID from the project's engagement push notifications list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Surveys

**Slug:** `GLEAP_DELETE_ENGAGEMENT_SURVEYS`

Tool to delete an engagement survey. Use when you need to remove a survey from the project by its survey ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `surveyId` | string | Yes | The unique identifier of the survey to delete. Must be a valid survey ID from the engagement surveys list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement Tooltips

**Slug:** `GLEAP_DELETE_ENGAGEMENT_TOOLTIPS`

Tool to delete an engagement tooltip. Use when you need to remove a tooltip from the project by its tooltip ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tooltipId` | string | Yes | The unique identifier (ObjectId) of the tooltip to delete. Must be a valid tooltip ID from the project's engagement tooltips list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Engagement WhatsApp Message

**Slug:** `GLEAP_DELETE_ENGAGEMENT_WHATSAPP_MESSAGE`

Tool to delete an engagement WhatsApp message by its ID. Use when you need to remove a WhatsApp message from the project's engagement WhatsApp messages list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `whatsappMessageId` | string | Yes | The unique identifier (ObjectId) of the WhatsApp message to delete. Must be a valid WhatsApp message ID from the project's engagement WhatsApp messages list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Help Center Collection

**Slug:** `GLEAP_DELETE_HELPCENTER_COLLECTION`

Tool to delete a help center collection by ID. Use when you need to permanently remove a collection from the help center.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `helpcenterCollectionId` | string | Yes | The unique identifier of the help center collection to delete. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Help Center Redirect

**Slug:** `GLEAP_DELETE_HELPCENTER_REDIRECT`

Tool to delete a help center redirect. Use when you need to remove a redirect from the help center by its redirect ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `redirectId` | string | Yes | The unique identifier of the help center redirect to delete. Must be a valid 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Message

**Slug:** `GLEAP_DELETE_MESSAGE`

Tool to delete a message (comment) from a bug or ticket. Use when you need to permanently remove a comment from a bug/ticket conversation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messageId` | string | Yes | The unique identifier of the message/comment to delete. Must be a valid 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Message Template

**Slug:** `GLEAP_DELETE_MESSAGE_TEMPLATE`

Tool to delete a message template. Use when you need to remove a message template from the project by its template ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messageTemplateId` | string | Yes | The unique identifier (ObjectId) of the message template to delete. Must be a valid message template ID from the project's message templates list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Old AI Content Batches

**Slug:** `GLEAP_DELETE_OLD_AI_CONTENT_BATCHES`

Delete all AI content batches except the current batch. Use when cleaning up old AI content and keeping only the latest batch by providing its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Optional type filter to specify which type of AI content batches to delete. |
| `currentBatchId` | string | Yes | The unique identifier of the current batch to keep. All other AI content batches will be deleted except this one. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete QA Answer

**Slug:** `GLEAP_DELETE_PROJECTS_QAANSWERS`

Tool to delete a QA answer (snippet) from a Gleap project. Use when removing help center content or AI assistant snippets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | The unique identifier of the project containing the QA answer/snippet. This is provided in the API authentication headers. |
| `qaanswer_id` | string | Yes | The unique identifier of the QA answer/snippet to delete. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete project session

**Slug:** `GLEAP_DELETE_PROJECTS_SESSIONS`

Tool to delete a session from a Gleap project. Use when you need to remove session data by providing both project ID and session ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `project_id` | string | Yes | The unique identifier of the project containing the session to delete. Must be a valid project ID. |
| `session_id` | string | Yes | The unique identifier of the session to delete from the project. Must be a valid session ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete session

**Slug:** `GLEAP_DELETE_SESSIONS`

Tool to delete a session by ID. Use when you need to remove a specific session from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sessionId` | string | Yes | The unique identifier of the session to delete. Must be a valid session ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Team

**Slug:** `GLEAP_DELETE_TEAM`

Tool to delete a team by ID. Use when you need to permanently remove a team from the project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `teamId` | string | Yes | The unique identifier of the team to delete. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Ticket

**Slug:** `GLEAP_DELETE_TICKET`

Tool to delete a ticket by ID. Use when you need to permanently remove a ticket from the system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticketId` | string | Yes | The unique identifier of the ticket to delete. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export sessions

**Slug:** `GLEAP_EXPORT_SESSIONS`

Tool to export all sessions for the authenticated project in CSV format. Use when you need to export session data for analysis, reporting, or backup purposes. Returns comprehensive session information in CSV format including user details, activity data, and metadata. No parameters required - automatically exports all sessions for the project specified in the authentication headers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Export Statistics Lists

**Slug:** `GLEAP_EXPORT_STATISTICS_LISTS`

Tool to export statistics list data as CSV from Gleap. Use when you need to export performance metrics, analytics, or reports. Supports various report types including team performance, article statistics, ticket ratings, SLA reports, and more. Results can be filtered by date range, grouped by time intervals, and paginated for large datasets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination |
| `limit` | integer | No | Maximum number of records to return |
| `endDate` | string | No | End date for filtering statistics (ISO 8601 format) |
| `aggsType` | string | No | Type of aggregation to apply to the statistics |
| `timezone` | string | No | Timezone for date calculations (e.g., 'America/New_York', 'Europe/London', 'UTC') |
| `chartType` | string ("AVERAGE_RATING_PER_USER_RESULT_LIST" | "TEAM_PERFORMANCE_LIST" | "ARTICLE_SEARCH_RESULT_LIST" | "ARTICLE_SEARCH_WITH_NO_RESULT_LIST" | "ARTICLE_VIEW_STATISTICS_LIST" | "TICKETS_WITH_RATING_LIST" | "LIVE_AGENTS_TEAM" | "SNAPSHOT_TICKETS" | "LATEST_NEGATIVE_AI_FEEDBACK" | "SLA_REPORTS_LIST") | Yes | Type of statistics list data to export (e.g., TEAM_PERFORMANCE_LIST, ARTICLE_VIEW_STATISTICS_LIST) |
| `createdAt` | string | No | Filter by creation date (ISO 8601 format) |
| `groupedBy` | string | No | Field to group results by |
| `startDate` | string | No | Start date for filtering statistics (ISO 8601 format) |
| `updatedAt` | string | No | Filter by last update date (ISO 8601 format) |
| `groupInterval` | string ("day" | "month" | "year") | No | Time grouping interval for statistics. |
| `useWorkingHours` | boolean | No | Whether to use working hours for time calculations (excludes weekends/holidays) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate ticket draft reply

**Slug:** `GLEAP_GENERATE_TICKET_DRAFT_REPLY`

Tool to generate an AI-powered draft reply for a ticket. Use when you need to automatically create a contextual response based on the ticket content, similar tickets, and knowledge base articles. The AI analyzes the ticket and suggests an appropriate reply that can be reviewed and sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticketId` | string | Yes | The unique identifier (ID) of the ticket to generate a draft reply for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate tracker ticket data

**Slug:** `GLEAP_GENERATE_TRACKER_TICKET_DATA`

Tool to generate AI-powered tracker ticket data from an existing ticket. Use when you need to automatically create a title and description for a tracker ticket based on a source ticket's content. The AI analyzes the source ticket and generates appropriate metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Optional type parameter for the generation process. Specifies the type of data to generate. |
| `sourceTicketId` | string | Yes | The unique identifier of the source ticket to generate data from. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a Checklist

**Slug:** `GLEAP_GET_A_CHECKLIST_ACTION`

Tool to retrieve a specific engagement checklist by its ID. Use after obtaining a valid checklistId.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `checklistId` | string | Yes | Unique identifier of the checklist to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a Collection

**Slug:** `GLEAP_GET_A_COLLECTION`

Tool to retrieve a help center collection by ID. Use when you need to fetch specific collection details by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `helpcenterCollectionId` | string | Yes | ID of the help center collection to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get AI content

**Slug:** `GLEAP_GET_AI_CONTENT`

Tool to retrieve AI content by its content ID. Use when you need to fetch specific AI-generated or AI-managed content from Gleap's AI content system.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contentId` | string | Yes | The unique identifier of the AI content to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all articles

**Slug:** `GLEAP_GET_ALL_ARTICLES`

Tool to retrieve all articles in a help center collection. Use when you have a helpcenterCollectionId and want to list its articles.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `helpcenterCollectionId` | string | Yes | ID of the help center collection |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all chat messages

**Slug:** `GLEAP_GET_ALL_CHAT_MESSAGES`

Retrieves all engagement chat messages from the current Gleap project. Use this action to: - List all chat conversations across all sessions - Review customer support interactions and message history - Analyze chat engagement data and message patterns - Export or audit chat communications Returns messages sorted by creation date (newest first) with complete metadata including sender information, session details, content, and timestamps. No pagination parameters; fetches all available messages.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Collections

**Slug:** `GLEAP_GET_ALL_COLLECTIONS`

Retrieves all help center collections for the authenticated project. Collections are organizational containers in the help center that group related articles. Each collection can contain articles and nested sub-collections. Use this action to: - Get an overview of all collections in the help center - Check collection counts (articles and sub-collections) - Access collection metadata (titles, descriptions, audience filters) Returns an empty list if no collections exist in the project.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Invitations for a Project

**Slug:** `GLEAP_GET_ALL_INVITATIONS_FOR_A_PROJECT`

Retrieves all pending invitations for a project. Use this to list users who have been invited to join the project but haven't accepted yet. The project context is automatically determined from the authentication headers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get all sessions

**Slug:** `GLEAP_GET_ALL_SESSIONS`

Retrieves all user sessions for the authenticated project. This endpoint returns comprehensive session data including user information, activity timestamps, engagement metrics, and metadata for all sessions associated with the project. Useful for analytics, user tracking, and session management. No parameters required - automatically fetches all sessions for the authenticated project specified in the headers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Teams

**Slug:** `GLEAP_GET_ALL_TEAMS`

Tool to retrieve all teams. Use when you need a list of all teams for the authenticated project.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Tickets

**Slug:** `GLEAP_GET_ALL_TICKETS`

Retrieve tickets from a Gleap project with optional filtering, sorting, and pagination. This action fetches tickets from the authenticated Gleap project. Without parameters, it returns all tickets. Use filters to narrow results by type, status, priority, or spam classification. Results can be sorted and paginated for efficient data retrieval. Use cases: - List all open bugs: Set status='OPEN' and type='BUG' - Get recent tickets: Set sort='-createdAt' and limit=20 - Paginate through tickets: Use skip and limit parameters - Find high-priority issues: Set priority='HIGH'

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of tickets to skip for pagination. Use skip=(page-1)*limit for page-based pagination. |
| `sort` | string | No | Sort order for results. Examples: '-createdAt' (newest first), 'createdAt' (oldest first), 'priority', '-priority', '-updatedAt'. |
| `type` | string | No | Filter by ticket type. Examples: 'BUG', 'FEATURE_REQUEST'. Can specify multiple comma-separated: 'BUG,FEATURE_REQUEST'. |
| `limit` | integer | No | Maximum number of tickets to return. Default varies by API, maximum is 1000. |
| `isSpam` | boolean | No | Filter by spam classification. Set to false to exclude spam tickets. |
| `status` | string | No | Filter by ticket status. Examples: 'OPEN', 'DONE', 'INPROGRESS'. Can specify multiple comma-separated: 'OPEN,DONE'. |
| `archived` | boolean | No | Filter by archived state. Set to false to exclude archived tickets. |
| `priority` | string | No | Filter by priority level. Examples: 'HIGH', 'MEDIUM', 'LOW'. Can specify multiple comma-separated: 'HIGH,MEDIUM'. |
| `ignoreArchived` | boolean | No | Set to true to ignore archived tickets regardless of archived filter. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Users for a Project

**Slug:** `GLEAP_GET_ALL_USERS_FOR_A_PROJECT`

Tool to retrieve all users for a project. Use when you need to list every user associated with the current project.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a ticket

**Slug:** `GLEAP_GET_A_TICKET`

Retrieves complete details for a specific ticket by its ID. Use this action when you need to: - View full ticket information including title, description, status, and priority - Check ticket metadata like creation time, tags, and custom data - Access associated session and user information - Review AI-generated summaries and support recommendations Returns comprehensive ticket data including type (BUG/FEATURE_REQUEST), priority level, sentiment analysis, upvotes, linked tickets, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticketId` | string | Yes | The unique identifier (ID) of the ticket to retrieve. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get current user

**Slug:** `GLEAP_GET_CURRENT_USER`

Retrieves the authenticated user's profile including email, name, user type, availability status, notification preferences, and 2FA settings. No parameters required - uses authentication from headers. Returns detailed user information including notification preferences for different event types (tickets, assignments, mentions) and account settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement activities count

**Slug:** `GLEAP_GET_ENGAGEMENT_ACTIVITIES_COUNT`

Tool to retrieve the count of activities for a specific engagement. Use when you need to know how many activities are associated with an engagement without fetching all activity details.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `engagementId` | string | Yes | The unique identifier of the engagement to retrieve activities count for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement banner

**Slug:** `GLEAP_GET_ENGAGEMENT_BANNER`

Tool to retrieve an engagement banner by its ID. Use when you need to fetch specific banner details including title, message, button configuration, targeting settings, and display schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bannerId` | string | Yes | The unique identifier of the engagement banner to retrieve. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Banners

**Slug:** `GLEAP_GET_ENGAGEMENT_BANNERS`

Tool to retrieve all engagement banners from a Gleap project. Use when you need to list all banners for viewing, auditing, or selecting a specific banner for further operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement chat message

**Slug:** `GLEAP_GET_ENGAGEMENT_CHAT_MESSAGE`

Retrieves a specific engagement chat message by its ID. Use this action to fetch complete details of a single chat message including content, sender role, timestamps, and configuration settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `chatMessageId` | string | Yes | The unique identifier of the chat message to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Checklists

**Slug:** `GLEAP_GET_ENGAGEMENT_CHECKLISTS`

Tool to retrieve all engagement checklists for a project. Use when you need to get an overview of all available checklists.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Cobrowse

**Slug:** `GLEAP_GET_ENGAGEMENT_COBROWSE`

Retrieves all cobrowse product tours for the authenticated project. Cobrowse product tours are interactive guided experiences that help users navigate through features or workflows. Use this action to get an overview of all configured cobrowse tours in your project, including their status, steps, and settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement cobrowse by ID

**Slug:** `GLEAP_GET_ENGAGEMENT_COBROWSE_BY_ID`

Tool to retrieve a specific cobrowse product tour by its ID. Use when you need to fetch complete details of a single cobrowse tour including steps, settings, status, and configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cobrowseProductTourId` | string | Yes | The unique identifier of the cobrowse product tour to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement email

**Slug:** `GLEAP_GET_ENGAGEMENT_EMAIL`

Retrieves a specific engagement email by its ID. Use this action to fetch complete details of a single engagement email including name, subject, body content, status, and configuration settings like frequency, target audience, and scheduling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `engagementEmailId` | string | Yes | The unique identifier of the engagement email to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Emails

**Slug:** `GLEAP_GET_ENGAGEMENT_EMAILS`

Tool to retrieve all engagement emails from a Gleap project. Use when you need to list all emails for viewing, auditing, or selecting a specific email for further operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement modal

**Slug:** `GLEAP_GET_ENGAGEMENT_MODAL`

Tool to retrieve an engagement modal by its ID. Use when you need to fetch specific modal details including title, message, button configuration, targeting settings, and display schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `modalId` | string | Yes | The unique identifier of the engagement modal to retrieve. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Modals

**Slug:** `GLEAP_GET_ENGAGEMENT_MODALS`

Tool to retrieve all engagement modals from a Gleap project. Use when you need to list all modals for viewing, auditing, or selecting a specific modal for further operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement News

**Slug:** `GLEAP_GET_ENGAGEMENT_NEWS`

Tool to retrieve all engagement news articles from a Gleap project. Use when you need to list all news articles for viewing, auditing, or selecting a specific article for further operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement news article

**Slug:** `GLEAP_GET_ENGAGEMENT_NEWS_ARTICLE`

Retrieves a specific engagement news article by its ID. Use this action to fetch complete details of a single news article including content, configuration, targeting settings, and delivery schedule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `newsId` | string | Yes | The unique identifier of the engagement news article to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a Product Tour

**Slug:** `GLEAP_GET_ENGAGEMENT_PRODUCT_TOUR`

Tool to retrieve a specific engagement product tour by its ID. Use after obtaining a valid productTourId to fetch detailed tour configuration including steps, targeting, and timing settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `productTourId` | string | Yes | Unique identifier of the product tour to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Product Tours

**Slug:** `GLEAP_GET_ENGAGEMENT_PRODUCT_TOURS`

Tool to retrieve all engagement product tours for a project. Use when you need to get an overview of all available product tours.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement push notification

**Slug:** `GLEAP_GET_ENGAGEMENT_PUSH_NOTIFICATION`

Retrieves a specific engagement push notification by its ID. Use this action to fetch complete details of a single push notification including name, title, message content, status, and configuration settings like frequency, target audience, and scheduling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `pushNotificationId` | string | Yes | The unique identifier of the push notification to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Push Notifications

**Slug:** `GLEAP_GET_ENGAGEMENT_PUSH_NOTIFICATIONS`

Tool to retrieve all engagement push notifications from a Gleap project. Use when you need to list all push notifications for viewing, auditing, or selecting a specific push notification for further operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagements Activities

**Slug:** `GLEAP_GET_ENGAGEMENTS_ACTIVITIES`

Tool to retrieve all activities for a specific engagement. Use when you need to track user interactions, view engagement performance, or analyze activity patterns for a particular engagement campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `engagementId` | string | Yes | The unique identifier of the engagement to retrieve activities for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement recipients

**Slug:** `GLEAP_GET_ENGAGEMENTS_RECIPIENTS`

Tool to find and retrieve recipients for a specific engagement. Use when you need to: - View all recipients who received an engagement (email, push notification, etc.) - Check delivery status and engagement metrics for recipients - Track when recipients opened or clicked on engagement content

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `engagementId` | string | Yes | The unique identifier of the engagement to retrieve recipients for. This is a 24-character hexadecimal string (MongoDB ObjectId). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement statistics

**Slug:** `GLEAP_GET_ENGAGEMENTS_STATISTICS`

Tool to retrieve statistics for a specific engagement. Use when you need to analyze engagement performance metrics such as views, interactions, conversions, and user behavior data.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `engagementId` | string | Yes | The unique identifier of the engagement to retrieve statistics for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Survey

**Slug:** `GLEAP_GET_ENGAGEMENT_SURVEY`

Tool to retrieve a survey by its ID. Use when you need to view survey details including name, description, status, format, questions, and other configuration settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `surveyId` | string | Yes | The unique identifier of the survey to retrieve. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Surveys

**Slug:** `GLEAP_GET_ENGAGEMENT_SURVEYS`

Tool to retrieve all engagement surveys from a Gleap project. Use when you need to list all surveys for viewing, auditing, or selecting a specific survey for further operations.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Survey Responses

**Slug:** `GLEAP_GET_ENGAGEMENT_SURVEYS_RESPONSES`

Tool to retrieve all survey responses for a specific survey. Use when you need to get all responses submitted for a survey.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `surveyId` | string | Yes | The unique identifier of the survey to retrieve responses for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Survey Response Samples

**Slug:** `GLEAP_GET_ENGAGEMENT_SURVEYS_RESPONSES_SAMPLES`

Tool to retrieve survey response samples for a specific engagement survey. Use when you need to view example responses, analyze survey feedback patterns, or audit survey submissions for a particular survey.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `surveyId` | string | Yes | The unique identifier of the survey to retrieve response samples for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Summarize Survey Responses

**Slug:** `GLEAP_GET_ENGAGEMENT_SURVEYS_RESPONSES_SUMMARIZE`

Tool to retrieve an AI-generated summary of survey responses. Use when you need to analyze survey feedback, understand response patterns, or get insights from customer feedback without reviewing individual responses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `surveyId` | string | Yes | The unique identifier of the survey to summarize responses for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Tooltip by ID

**Slug:** `GLEAP_GET_ENGAGEMENT_TOOLTIP_BY_ID`

Tool to retrieve a specific engagement tooltip by its ID. Use when you need to get detailed information about a specific tooltip.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tooltipId` | string | Yes | Unique identifier of the tooltip to retrieve. Must be a valid tooltip ID from the project's engagement tooltips list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Engagement Tooltips

**Slug:** `GLEAP_GET_ENGAGEMENT_TOOLTIPS`

Tool to retrieve all engagement tooltips for the authenticated project. Use when you need to get a list of all configured tooltips.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get engagement WhatsApp message

**Slug:** `GLEAP_GET_ENGAGEMENT_WHATSAPP_MESSAGE`

Retrieves a specific engagement WhatsApp message by its ID. Use this action to fetch complete details of a single WhatsApp message including content, status, and configuration settings like frequency, target audience, and scheduling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `whatsappMessageId` | string | Yes | The unique identifier of the WhatsApp message to retrieve. Must be a valid 24-character MongoDB ObjectId (hexadecimal string). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Help Center Sources

**Slug:** `GLEAP_GET_HELP_CENTER_SOURCES`

Retrieves all configured help center sources (knowledge base content sources) for the project. Returns a list of sources with their IDs, titles, URLs, and metadata. Use this to discover available help center content sources before querying articles or answering questions.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Invitations

**Slug:** `GLEAP_GET_INVITATIONS`

Retrieves all invitations for the authenticated user. Use this to list all pending invitations (both organisation and project invitations) associated with the current user. The user context is automatically determined from the authentication headers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get message template

**Slug:** `GLEAP_GET_MESSAGE_TEMPLATE`

Retrieves a specific message template by its ID from a Gleap project. Use this when you need to fetch the details of a particular message template including its title, content, visibility settings, and associated metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `messageTemplateId` | string | Yes | The unique identifier (ID) of the message template to retrieve. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Message Templates

**Slug:** `GLEAP_GET_MESSAGE_TEMPLATES`

Retrieve all message templates for the authenticated project. Use when you need to list available message templates for customer communication. Message templates are pre-defined message formats that can be used for consistent communication with users. This action supports optional filtering via search term and pagination with a limit parameter.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum number of message templates to return. Use for pagination. |
| `searchTerm` | string | No | Search term to filter message templates by title or content. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get notification ticket

**Slug:** `GLEAP_GET_NOTIFICATION_TICKET`

Retrieves detailed information about a Gleap ticket using its notification share token. Use this action to access public ticket details via a share token, which is typically obtained from ticket notifications or webhooks. This allows viewing ticket information without requiring full authentication. Returns comprehensive ticket data including title, description, status, priority, tags, and session information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `shareToken` | string | Yes | The share token from a Gleap ticket notification. This token allows public access to view ticket details without authentication. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get project

**Slug:** `GLEAP_GET_PROJECT`

Retrieves complete details for a specific project by its ID. Use when you need to view project configuration, settings, notification preferences, or metadata for a single project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the project to retrieve. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Projects

**Slug:** `GLEAP_GET_PROJECTS`

Retrieves all projects accessible to the authenticated user. Use when you need to list all projects the user has access to. Rate limit: 1000 requests per minute.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get archived bugs

**Slug:** `GLEAP_GET_PROJECTS_BUGS_ARCHIVE`

Tool to retrieve archived bugs for a specific project. Use when you need to view bugs that have been archived or moved to history for a given project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The project ID to retrieve archived bugs for (MongoDB ObjectId format, 24-character hexadecimal string) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Projects Help Center Collections

**Slug:** `GLEAP_GET_PROJECTS_HELPCENTER_COLLECTIONS`

Tool to get all help center collections for a project. Use when you need to retrieve the complete list of help center collections including their metadata, titles, descriptions, and audience targeting settings.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get project sessions

**Slug:** `GLEAP_GET_PROJECTS_SESSIONS`

Tool to retrieve all sessions for a specific project. Use when you need to get session data for a particular project by its ID. Returns comprehensive session information including user details, activity timestamps, and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The project ID to retrieve sessions for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Projects Tickets

**Slug:** `GLEAP_GET_PROJECTS_TICKETS`

Tool to retrieve all tickets from a specific Gleap project. Use when you need to get tickets for a particular project by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The project ID to retrieve tickets from. This is a MongoDB ObjectId format string (24-character hexadecimal). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get project users

**Slug:** `GLEAP_GET_PROJECTS_USERS`

Tool to get project users by project ID. Use when you need to list all users associated with a specific project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The project ID (MongoDB ObjectId format, 24-character hexadecimal string) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get a session

**Slug:** `GLEAP_GET_SESSION`

Retrieves detailed information for a specific session by its ID. Use this when you need to fetch comprehensive session data including user information, activity timestamps, engagement metrics, and custom metadata for a particular session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sessionId` | string | Yes | The unique identifier of the session to retrieve. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get session activities

**Slug:** `GLEAP_GET_SESSION_ACTIVITIES`

Retrieves all activities for a specific session by session ID. Use this action when you need to fetch detailed activity data for a particular session, including user interactions and session events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | The unique identifier of the session to retrieve activities for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get session Chargebee info

**Slug:** `GLEAP_GET_SESSION_CHARGEBEE_INFO`

Tool to retrieve Chargebee billing information for a specific session. Use when you need to fetch subscription, payment, or billing details associated with a user session from Chargebee.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | The unique identifier of the session. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Checklists

**Slug:** `GLEAP_GET_SESSION_CHECKLISTS`

Retrieve all engagement checklists associated with a user session in Gleap. Engagement checklists help track user progress through onboarding flows, feature adoption, or guided workflows. Use this after obtaining a valid session ID (e.g., from Get All Sessions). Returns an empty list if the session has no associated checklists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sessionId` | string | Yes | The unique MongoDB ObjectId of the session (24-character hexadecimal string) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get session events by ID

**Slug:** `GLEAP_GET_SESSION_EVENTS`

Tool to retrieve all streamed events for a specific session by its ID. Use when you need to get detailed event stream data for debugging user behavior or analyzing session activity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `session_id` | string | Yes | The unique identifier of the session to retrieve events for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get session LemonSqueezy info

**Slug:** `GLEAP_GET_SESSION_LEMON_SQUEEZY_INFO`

Tool to retrieve LemonSqueezy subscription and payment information for a specific session. Use when you need to fetch LemonSqueezy data associated with a user session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sessionId` | string | Yes | The unique identifier of the session. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Session Shopify Info

**Slug:** `GLEAP_GET_SESSION_SHOPIFY_INFO`

Retrieve Shopify information associated with a user session in Gleap. Use this when you need to access e-commerce data from Shopify linked to a specific session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sessionId` | string | Yes | The unique MongoDB ObjectId of the session (24-character hexadecimal string) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Shared Help Center Answer

**Slug:** `GLEAP_GET_SHARED_HELPCENTER_ANSWER`

Retrieves an answer to a question from the shared help center knowledge base. Use this when you need to find information from help center articles based on a user's question. The endpoint searches through configured help center sources and returns the most relevant answer. Returns null if no matching answer is found.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `question` | string | Yes | The question to answer from the help center. This should be a clear, specific question that can be matched against help center articles and documentation. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get email client bounce statistics

**Slug:** `GLEAP_GET_STATISTICS_EMAIL_CLIENT_BOUNCES`

Tool to retrieve email client bounce statistics from Gleap. Use when you need to analyze email delivery failures and bounce rates over time. The statistics can be filtered by date range, grouped by time intervals (day, month, year), and filtered by specific email server configurations.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination. Use with limit to paginate through results. |
| `limit` | integer | No | Maximum number of records to return. Use with skip for pagination. |
| `endDate` | string | No | End date for filtering statistics (ISO 8601 format, e.g., '2024-12-31T23:59:59Z'). Only statistics up to this date will be included. |
| `aggsType` | string | No | Type of aggregation to perform on the statistics data. |
| `timezone` | string | No | Timezone for date calculations (e.g., 'America/New_York', 'Europe/London', 'UTC'). Used to properly calculate date-based statistics in the specified timezone. |
| `createdAt` | string | No | Filter by creation timestamp (ISO 8601 format). |
| `groupedBy` | string | No | Field to group statistics by. Allows grouping data by specific dimensions. |
| `startDate` | string | No | Start date for filtering statistics (ISO 8601 format, e.g., '2024-01-01T00:00:00Z'). Only statistics from this date onwards will be included. |
| `updatedAt` | string | No | Filter by last update timestamp (ISO 8601 format). |
| `groupInterval` | string ("day" | "month" | "year") | No | Group interval for statistics aggregation. |
| `emailServerKey` | string | No | Filter statistics by specific email server key. Use to get bounce statistics for a particular email server configuration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Email Client Usage Statistics

**Slug:** `GLEAP_GET_STATISTICS_EMAIL_CLIENT_USAGE`

Tool to retrieve email client usage statistics from Gleap. Returns metrics such as sent emails, bounces, spam reports, and open rates. Use when you need to analyze email delivery performance, track email engagement, or monitor email client behavior over time. Note: The API typically requires startDate and endDate parameters to function properly.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination. Use with limit for paginated results. |
| `limit` | integer | No | Maximum number of records to return. Use with skip for pagination. |
| `endDate` | string | No | End date for filtering statistics in ISO 8601 format (e.g., '2024-12-31T23:59:59.999Z'). Highly recommended to provide this parameter. |
| `aggsType` | string | No | Type of aggregation to apply to the statistics (e.g., 'sum', 'avg', 'count'). |
| `timezone` | string | No | Timezone for date calculations (e.g., 'America/New_York', 'Europe/London', 'UTC'). |
| `createdAt` | string | No | Filter by creation date in ISO 8601 format. |
| `groupedBy` | string | No | Field to group statistics by (e.g., 'emailClient', 'browser'). |
| `startDate` | string | No | Start date for filtering statistics in ISO 8601 format (e.g., '2024-01-01T00:00:00.000Z'). Highly recommended to provide this parameter. |
| `updatedAt` | string | No | Filter by last update date in ISO 8601 format. |
| `groupInterval` | string ("day" | "month" | "year") | No | Time interval for grouping statistics data. |
| `emailServerKey` | string | No | Filter statistics by specific email server key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get email overview statistics

**Slug:** `GLEAP_GET_STATISTICS_EMAIL_OVERVIEW`

Tool to retrieve email overview statistics from Gleap. Use when you need to analyze email campaign performance metrics such as sent, delivered, opened, clicked, bounced emails, and engagement rates over a specified time period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination. Use skip=(page-1)*limit for page-based pagination. |
| `limit` | integer | No | Maximum number of records to return. Use together with skip for pagination. |
| `endDate` | string | No | End date for filtering statistics in ISO 8601 format (e.g., '2024-12-31T23:59:59.999Z'). Only statistics up to this date will be included. |
| `aggsType` | string | No | Aggregation type for the statistics. Defines how data should be aggregated across the specified grouping. |
| `timezone` | string | No | Timezone for date calculations (e.g., 'America/New_York', 'Europe/London'). If not specified, uses server default timezone. |
| `createdAt` | string | No | Filter by creation timestamp in ISO 8601 format. Used to filter records based on when they were created. |
| `groupedBy` | string | No | Field to group the statistics by. Can be used to aggregate data by specific dimensions. |
| `startDate` | string | No | Start date for filtering statistics in ISO 8601 format (e.g., '2024-01-01T00:00:00.000Z'). Only statistics from this date onwards will be included. |
| `updatedAt` | string | No | Filter by last update timestamp in ISO 8601 format. Used to filter records based on when they were last modified. |
| `groupInterval` | string ("day" | "month" | "year") | No | Time interval for grouping statistics data. |
| `emailServerKey` | string | No | Specific email server key to filter statistics for a particular email server configuration. Use to get statistics for a specific email integration. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get statistics facts

**Slug:** `GLEAP_GET_STATISTICS_FACTS`

Tool to retrieve fact data for various statistics from Gleap. Use when you need statistical insights about tickets, AI interactions, help center engagement, or SLA performance for a specific time period.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination. Use with limit for paginated results. |
| `limit` | integer | No | Maximum number of records to return. Use with skip for pagination. |
| `endDate` | string | No | End date for filtering statistics data. Use ISO 8601 format (YYYY-MM-DD or full timestamp). Only data up to this date will be included. |
| `aggsType` | string | No | Aggregation type for calculations. Supported values: 'MEDIAN' or 'AVERAGE'. Determines how metrics are calculated across time periods. |
| `timezone` | string | No | Timezone for date calculations. Use standard timezone identifiers like 'America/New_York' or 'Europe/London'. Affects how date ranges are interpreted. |
| `chartType` | string ("MEDIAN_FIRST_RESPONSE_TIME" | "MEDIAN_TIME_TO_CLOSE" | "TICKET_CLOSE_COUNT" | "MEDIAN_CONVERSATION_RATING" | "TICKET_MEDIAN_REPLY_TIME" | "MEDIAN_FIRST_ASSIGNMENT_TIME" | "NEW_TICKETS_COUNT" | "TICKET_COUNT_BY_QUERY" | "TICKET_REPLIES_COUNT" | "TICKET_WORKED_ON_COUNT" | "TICKETS_WITH_OTHER_STATUS_THEN_OPEN_OR_CLOSED_COUNT" | "HELP_CENTER_ARTICLE_VIEW_COUNT" | "NEWS_VIEW_COUNT" | "KAI_ANSWERED_COUNT" | "KAI_NO_ANSWER_COUNT" | "KAI_ROUTED_TO_AGENT_RATE_COUNT" | "KAI_DEFLECTION_RATE" | "KAI_DEFLECTION_RATE_UNIQUE_USERS" | "KAI_ROUTED_TO_AGENT_RATE_UNIQUE_USERS" | "KAI_ROUTED_TO_AGENT_RATE" | "KAI_POSITIVE_FEEDBACK_RATE" | "KAI_NEGATIVE_FEEDBACK_RATE" | "KAI_POSITIVE_FEEDBACK_PERCENTAGE" | "SNAPSHOT_AGENTS_ONLINE_COUNT" | "SNAPSHOT_OPEN_TICKETS" | "MESSAGE_COUNT" | "AI_QUESTIONS_ASKED_COUNT" | "SLA_BREACHES_COUNT" | "SLA_COMPLIANCE" | "SLA_NOT_COMPLIANCE" | "SLA_NO_BREACHES_COUNT" | "TICKETS_WITHOUT_COMMENTS_RATE" | "KAI_DEFLECTION_COUNT" | "KAI_ROUTED_TO_AGENT_COUNT") | Yes | Type of fact data to retrieve. Determines what statistics are returned (e.g., NEW_TICKETS_COUNT for new ticket statistics, MEDIAN_TIME_TO_CLOSE for time-to-close metrics). |
| `createdAt` | string | No | Filter by creation timestamp. Format and usage may vary based on API requirements. |
| `groupedBy` | string | No | Field to group statistics by. Allows segmentation of data by specific attributes. |
| `startDate` | string | No | Start date for filtering statistics data. Use ISO 8601 format (YYYY-MM-DD or full timestamp). Only data from this date onwards will be included. |
| `updatedAt` | string | No | Filter by update timestamp. Format and usage may vary based on API requirements. |
| `groupInterval` | string ("day" | "month" | "year") | No | Enumeration of time grouping intervals for statistics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Statistics Heatmap

**Slug:** `GLEAP_GET_STATISTICS_HEATMAP`

Retrieve heatmap data for activity patterns in Gleap. Use when you need to visualize busiest hours per weekday or comment activity patterns. Returns aggregated data showing activity distribution across time dimensions, helpful for identifying peak usage times and activity trends.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination. Use skip=(page-1)*limit for page-based pagination. |
| `limit` | integer | No | Maximum number of records to return. Use with skip for pagination. |
| `endDate` | string | No | End date for filtering data (ISO 8601 format, e.g., '2024-12-31T23:59:59Z'). Only data up to this date is included. |
| `aggsType` | string | No | Aggregation type for data calculation. Determines how data points are combined. |
| `timezone` | string | No | Timezone for date calculations (e.g., 'America/New_York', 'Europe/London', 'UTC'). Affects how timestamps are interpreted. |
| `chartType` | string ("BUSIEST_HOURS_PER_WEEKDAY" | "BUSIEST_COMMENTS_PER_WEEKDAY") | Yes | Type of heatmap data to retrieve. BUSIEST_HOURS_PER_WEEKDAY shows activity patterns across hours and weekdays. BUSIEST_COMMENTS_PER_WEEKDAY shows comment activity patterns. Required. |
| `createdAt` | string | No | Filter by creation timestamp. Can be used for precise timestamp filtering. |
| `groupedBy` | string | No | Field to group results by. Allows additional data segmentation beyond the chart type. |
| `startDate` | string | No | Start date for filtering data (ISO 8601 format, e.g., '2024-01-01T00:00:00Z'). Only data from this date onwards is included. |
| `updatedAt` | string | No | Filter by last update timestamp. Can be used to find recently modified data. |
| `groupInterval` | string ("day" | "month" | "year") | No | Time interval for grouping data |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Statistics Lists

**Slug:** `GLEAP_GET_STATISTICS_LISTS`

Tool to retrieve statistics list data from Gleap. Use when you need to access performance metrics, analytics, or reports. Supports various report types including team performance, article statistics, ticket ratings, SLA reports, and more. Results can be filtered by date range, grouped by time intervals, and paginated for large datasets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination |
| `limit` | integer | No | Maximum number of records to return |
| `endDate` | string | No | End date for filtering statistics (ISO 8601 format) |
| `aggsType` | string | No | Type of aggregation to apply to the statistics |
| `timezone` | string | No | Timezone for date calculations (e.g., 'America/New_York', 'Europe/London', 'UTC') |
| `chartType` | string ("AVERAGE_RATING_PER_USER_RESULT_LIST" | "TEAM_PERFORMANCE_LIST" | "ARTICLE_SEARCH_RESULT_LIST" | "ARTICLE_SEARCH_WITH_NO_RESULT_LIST" | "ARTICLE_VIEW_STATISTICS_LIST" | "TICKETS_WITH_RATING_LIST" | "LIVE_AGENTS_TEAM" | "SNAPSHOT_TICKETS" | "LATEST_NEGATIVE_AI_FEEDBACK" | "SLA_REPORTS_LIST") | Yes | Type of statistics list data to retrieve (e.g., TEAM_PERFORMANCE_LIST, ARTICLE_VIEW_STATISTICS_LIST) |
| `createdAt` | string | No | Filter by creation date (ISO 8601 format) |
| `groupedBy` | string | No | Field to group results by |
| `startDate` | string | No | Start date for filtering statistics (ISO 8601 format) |
| `updatedAt` | string | No | Filter by last update date (ISO 8601 format) |
| `groupInterval` | string ("day" | "month" | "year") | No | Time grouping interval for statistics. |
| `useWorkingHours` | boolean | No | Whether to use working hours for time calculations (excludes weekends/holidays) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Statistics Raw Data

**Slug:** `GLEAP_GET_STATISTICS_RAW_DATA`

Tool to retrieve raw statistics data from Gleap. Use when you need unprocessed, granular statistical data for custom analysis or reporting.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of records to skip for pagination. Use with limit for paginated results. |
| `type` | string | No | Type of raw data to retrieve. Specifies the category or kind of statistics data to fetch. |
| `limit` | integer | No | Maximum number of records to return. Use with skip for pagination. |
| `endDate` | string | No | End date for filtering raw statistics data. Use ISO 8601 format (YYYY-MM-DD or full timestamp). Only data up to this date will be included. |
| `aggsType` | string | No | Aggregation type for calculations. Determines how metrics are calculated across time periods or groups. |
| `timezone` | string | No | Timezone for date calculations. Use standard timezone identifiers like 'America/New_York', 'Europe/London', or 'UTC'. Affects how date ranges and timestamps are interpreted. |
| `createdAt` | string | No | Filter by creation timestamp. Format and usage may vary based on API requirements. |
| `groupedBy` | string | No | Field to group statistics by. Allows segmentation of raw data by specific attributes or dimensions. |
| `startDate` | string | No | Start date for filtering raw statistics data. Use ISO 8601 format (YYYY-MM-DD or full timestamp). Only data from this date onwards will be included. |
| `updatedAt` | string | No | Filter by update timestamp. Format and usage may vary based on API requirements. |
| `groupInterval` | string ("day" | "month" | "year") | No | Time grouping interval for statistics data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tickets By Session Query

**Slug:** `GLEAP_GET_TICKETS_BY_SESSION_QUERY`

Find tickets by session query parameters such as email, userId, phone, or custom data. Use this when you need to retrieve tickets associated with a specific user session or contact information.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | No | Email address to search for tickets. Finds tickets associated with sessions that have this email. |
| `phone` | string | No | Phone number to search for tickets. Finds tickets associated with sessions that have this phone number. |
| `userId` | string | No | User ID to search for tickets. Finds tickets associated with sessions that have this user ID. |
| `customData.TIN` | string | No | Custom data TIN field to search for tickets. Finds tickets associated with sessions that have this TIN in custom data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tickets Export

**Slug:** `GLEAP_GET_TICKETS_EXPORT`

Export tickets from Gleap project with optional filtering and sorting. This action retrieves tickets in an export format suitable for data analysis, reporting, or backup purposes. Use filters to narrow the export to specific ticket types, statuses, or priorities. The project is automatically identified from authentication headers.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `skip` | integer | No | Number of tickets to skip for pagination. |
| `sort` | string | No | Sort order for exported tickets. Examples: '-createdAt' (newest first), 'createdAt' (oldest first), 'priority', '-priority', '-updatedAt'. |
| `type` | string | No | Filter exported tickets by type. Examples: 'BUG', 'FEATURE_REQUEST'. Can specify multiple comma-separated: 'BUG,FEATURE_REQUEST'. |
| `limit` | integer | No | Maximum number of tickets to export. Default varies by API. |
| `isSpam` | boolean | No | Filter by spam classification. Set to false to exclude spam tickets from export. |
| `status` | string | No | Filter exported tickets by status. Examples: 'OPEN', 'DONE', 'INPROGRESS'. Can specify multiple comma-separated: 'OPEN,DONE'. |
| `archived` | boolean | No | Filter by archived state. Set to false to exclude archived tickets from export. |
| `priority` | string | No | Filter exported tickets by priority level. Examples: 'HIGH', 'MEDIUM', 'LOW'. Can specify multiple comma-separated: 'HIGH,MEDIUM'. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tickets Export Fields

**Slug:** `GLEAP_GET_TICKETS_EXPORT_FIELDS`

Retrieve available fields for ticket export from Gleap. This action fetches metadata about which fields can be exported for tickets, useful for understanding what data is available before performing a ticket export.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | No | Filter by export type. Optional parameter to specify the type of export fields to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search Tickets by Term

**Slug:** `GLEAP_GET_TICKETS_SEARCH`

Search for tickets using a text search term in Gleap. Use when you need to find tickets based on keywords or phrases in titles and descriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `searchTerm` | string | Yes | The search term to query tickets. This will search across ticket titles, descriptions, and other relevant fields. Required parameter for ticket search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Tickets Count

**Slug:** `GLEAP_GET_TICKETS_TICKETSCOUNT`

Tool to get the total count of tickets in a Gleap project. Use when you need to know how many tickets exist without retrieving full ticket details.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get current user's permissions

**Slug:** `GLEAP_GET_USERS_ME_PERMISSIONS`

Tool to retrieve the current user's role permissions. Use when you need to check what permissions the authenticated user has.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get users unified inbox

**Slug:** `GLEAP_GET_USERS_UNIFIED_INBOX`

Retrieves tickets from the unified inbox for the authenticated user. Use this action to view all tickets assigned to or accessible by the current user across projects. Supports filtering by ticket type, project ID, and pagination for large result sets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Starts at 1. Use this to navigate through multiple pages of tickets. |
| `type` | string | No | Filter tickets by type. Common values include 'BUG', 'FEATURE_REQUEST', 'FEEDBACK', 'QUESTION', 'CRASH'. Leave empty to fetch all ticket types. |
| `limit` | integer | No | Number of tickets to return per page. Maximum 100. Use this to control the number of results returned. |
| `filteredProjectId` | string | No | Filter tickets by specific project ID. Use this to view tickets from a particular project only. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get users unified inbox ticket

**Slug:** `GLEAP_GET_USERS_UNIFIED_INBOX_TICKET`

Retrieves complete details for a specific ticket from the unified inbox by its ID. Use this action when you need to: - View full unified inbox ticket information including title, description, status, and priority - Check ticket metadata like creation time, tags, and custom data - Access associated session and user information - Review notification status and agent replies - Get AI-generated summaries and support recommendations The unified inbox provides a consolidated view of tickets across different channels. Returns comprehensive ticket data including type, priority level, sentiment analysis, upvotes, linked tickets, and custom fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticketId` | string | Yes | The unique identifier (ID) of the unified inbox ticket to retrieve. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Identify or update user

**Slug:** `GLEAP_IDENTIFY_USER`

Identify or update a user's information in Gleap. Creates a new user if the userId doesn't exist, or updates the existing user's profile data. Use this to sync user information from your application to Gleap for customer support and feedback tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | User’s full name. |
| `email` | string | No | User’s email address. |
| `phone` | string | No | User’s phone number. |
| `value` | number | No | Monetary or lifetime value associated with the user. |
| `userId` | string | Yes | Unique identifier of the user. This will create a new user if the ID doesn't exist, or update an existing user's information. |
| `createdAt` | string | No | Explicit user creation timestamp (ISO 8601). |
| `preventLastActivityUpdate` | boolean | No | If true, prevents updating the user’s last activity timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import session

**Slug:** `GLEAP_IMPORT_SESSION`

Import user sessions into Gleap for tracking and analytics. Use this action to: - Bulk import user session data from external systems - Migrate user data from other platforms into Gleap - Synchronize user information with Gleap's session tracking - Create or update user profiles with associated metadata Each session must include a userId, and can optionally include email, name, phone, avatar, language, company information, custom data, plan, value, and tags.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sessions` | array | Yes | Array of session objects to import. Must contain at least one session. Each session represents a user and their associated data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import sessions from Intercom

**Slug:** `GLEAP_IMPORT_SESSIONS_FROM_INTERCOM`

Import user sessions from Intercom into Gleap. Use this to synchronize contact data and session information from your Intercom workspace to Gleap for unified customer support tracking.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `apiKey` | string | Yes | Intercom API access token for authentication. This key must have read permissions for contacts in your Intercom workspace. |
| `endpoint` | string | Yes | Intercom API endpoint URL to fetch contacts from. Typically 'https://api.intercom.io/contacts' for retrieving contact data. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Indicate user typing

**Slug:** `GLEAP_INDICATE_USER_TYPING`

Tool to indicate that a user is typing in a ticket conversation. Use this to show real-time typing indicators to other users viewing the same ticket. Set typing to true when starting to type and false when finished.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `typing` | boolean | Yes | Whether the user is currently typing. Set to true to indicate typing is in progress, false to indicate typing has stopped. |
| `ticketId` | string | Yes | The unique identifier (ID) of the ticket. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Indicate user viewing

**Slug:** `GLEAP_INDICATE_USER_VIEWING`

Tool to indicate that a user is viewing a ticket. Use this to show real-time viewing indicators to other users accessing the same ticket. Set viewing to true when starting to view and false when finished.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `viewing` | boolean | Yes | Whether the user is currently viewing the ticket. Set to true to indicate the user is viewing the ticket, false to indicate the user has stopped viewing. |
| `ticketId` | string | Yes | The unique identifier (ID) of the ticket. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Link a Ticket

**Slug:** `GLEAP_LINK_A_TICKET`

Tool to link a ticket. Use when you need to connect two existing tickets after confirming both IDs exist. Example: Link a duplicate issue ticket to its original.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticketId` | string | Yes | ID of the source ticket to link from |
| `targetTicketId` | string | Yes | ID of the target ticket to link to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Mark Survey Responses as Read

**Slug:** `GLEAP_MARK_SURVEY_RESPONSES_READ`

Tool to mark all survey responses as read for a given survey. Use when you need to bulk-mark survey responses as read to clear unread indicators.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `surveyId` | string | Yes | Unique identifier of the survey whose responses should be marked as read |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Merge tickets

**Slug:** `GLEAP_MERGE_TICKETS`

Tool to merge multiple tickets into a single target ticket in Gleap. Use when you need to consolidate duplicate tickets or combine related tickets into one. You can either merge into an existing ticket by providing targetTicketId, or create a new ticket by setting shouldCreateNewTicket to true. Optionally merge contacts and tasks from all tickets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `targetTicketId` | string | No | The ID of the target ticket to merge into (required if shouldCreateNewTicket is false). This is the ticket that will contain all merged data. Must be a 24-character hexadecimal string. |
| `shouldMergeTasks` | boolean | Yes | Whether to merge tasks from all tickets. Set to true to combine tasks from the merged tickets, or false to keep only the target ticket's tasks. |
| `ticketsToMergeIds` | array | Yes | Array of ticket IDs to merge into the target ticket. These tickets will be merged and their data combined into the target ticket. Each ID is a 24-character hexadecimal string. |
| `shouldMergeContacts` | boolean | Yes | Whether to merge contact information from all tickets. Set to true to combine contacts from the merged tickets, or false to keep only the target ticket's contacts. |
| `shouldCreateNewTicket` | boolean | Yes | Whether to create a new ticket as the merge target. Set to true to create a new ticket for the merged data, or false to merge into an existing targetTicketId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Post a comment on a bug

**Slug:** `GLEAP_POST_BUGS_COMMENTS`

Tool to post a comment/message on a bug or ticket in Gleap. Use when you need to add a comment to an existing bug/ticket conversation, such as providing updates, asking questions, or documenting resolution steps.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the bug/ticket to add a comment to. This is a 24-character hexadecimal string. |
| `message` | string | Yes | The text content of the comment message to post on the bug/ticket. Supports unicode characters, emojis, and special characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement News Article

**Slug:** `GLEAP_POST_ENGAGEMENT_NEWS`

Tool to create a new engagement news article in Gleap. Use when you need to publish announcements, product updates, or news content to users. Configure scheduling, targeting, and display frequency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name/title of the news article |
| `sent` | boolean | Yes | Whether the news article has been sent/published to users |
| `type` | string | Yes | Type of engagement item, typically 'news' for news articles |
| `sound` | boolean | Yes | Whether to play a notification sound when displaying the news article |
| `format` | string | Yes | Display format for the news article (e.g., 'standard', 'widget', 'modal') |
| `hidden` | boolean | Yes | Whether the news article is hidden from users. Set to true to hide, false to show |
| `status` | string | Yes | Publication status: 'draft' or 'active'. Use 'draft' for unpublished articles, 'active' for published |
| `createdAt` | string | Yes | ISO 8601 timestamp when the article was created (e.g., '2026-02-14T10:00:00Z') |
| `frequency` | string | Yes | Frequency at which the news article is shown: 'once', 'always', 'daily', etc. |
| `updatedAt` | string | Yes | ISO 8601 timestamp when the article was last updated (e.g., '2026-02-14T10:00:00Z') |
| `newTrigger` | boolean | Yes | Whether this is a new trigger for the news article |
| `frequencyDays` | integer | Yes | Number of days for frequency calculation (e.g., 0 for immediate, 7 for weekly) |
| `frequencyType` | string | Yes | Type of frequency calculation: 'daily', 'weekly', 'monthly', etc. |
| `pageFilterType` | string ("is" | "contains" | "isnot" | "notcontains" | "startswith" | "endswith" | "empty" | "notempty") | Yes | Type of page filtering to apply: 'is' for exact match, 'contains' for partial match, 'isnot' for exclusion, etc. |
| `targetAudience` | string | Yes | Target audience for the news article: 'all' for everyone, 'specific' for filtered audience |
| `stopSendingAfter` | string | Yes | ISO 8601 timestamp when to stop sending/displaying the news article (e.g., '2026-12-31T23:59:59Z') |
| `startSendingAfter` | string | Yes | ISO 8601 timestamp when to start sending/displaying the news article (e.g., '2026-02-14T10:00:00Z') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Engagement Survey

**Slug:** `GLEAP_POST_ENGAGEMENT_SURVEYS`

Tool to create a new survey in Gleap. Use when you want to create a customer feedback survey, product satisfaction survey, or any user engagement survey. Only the name field is required; all other fields are auto-populated with defaults (status='draft', type='SURVEY', format='widget', frequency='once').

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the survey (required) |
| `description` | string | No | Description of the survey |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create WhatsApp Engagement Message

**Slug:** `GLEAP_POST_ENGAGEMENT_WHATSAPP_MESSAGES`

Tool to create a new WhatsApp message in Gleap for user engagement. Use when you want to send WhatsApp messages for customer support, announcements, or marketing campaigns. All fields are optional; the API will create a message with default values (name: 'New whatsapp message', type: 'WHATSAPP', status: 'draft', sound: true, hidden: false, sent: false, format: 'widget', frequencyType: 'dynamic', frequency: 'once', frequencyDays: 0).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the WhatsApp message. Defaults to 'New whatsapp message' if not specified |
| `sent` | boolean | No | Whether the message has been sent to users. Defaults to false if not specified |
| `type` | string | No | Type of engagement element. Defaults to 'WHATSAPP' if not specified |
| `sound` | boolean | No | Whether to play a notification sound. Defaults to true if not specified |
| `format` | string | No | Display format for the message. Defaults to 'widget' if not specified |
| `hidden` | boolean | No | Whether the message is hidden from users. Defaults to false if not specified |
| `status` | string | No | Message status: 'draft' or 'active'. Defaults to 'draft' if not specified |
| `frequency` | string | No | Frequency at which the message is shown: 'once', 'always', 'daily', etc. Defaults to 'once' if not specified |
| `newTrigger` | boolean | No | Whether this is a new trigger for the message |
| `frequencyDays` | integer | No | Number of days for frequency calculation. Defaults to 0 if not specified |
| `frequencyType` | string | No | Type of frequency calculation: 'dynamic', 'daily', 'weekly', etc. Defaults to 'dynamic' if not specified |
| `pageFilterType` | string | No | Type of page filtering to apply: 'all', 'specific', 'exclude', etc. |
| `targetAudience` | string | No | Target audience for the message: 'all', 'specific', etc. Determines who receives the message |
| `stopSendingAfter` | string | No | ISO 8601 timestamp when to stop sending the message (e.g., '2026-12-31T23:59:59Z') |
| `startSendingAfter` | string | No | ISO 8601 timestamp when to start sending the message (e.g., '2026-02-14T10:00:00Z') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Reassign all tickets to user

**Slug:** `GLEAP_REASSIGN_ALL_TICKETS_TO_USER`

Tool to reassign all tickets to the authenticated user. Use when you need to bulk reassign tickets to yourself for handling or review.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Resubscribe a Session

**Slug:** `GLEAP_RESUBSCRIBE_A_SESSION`

Tool to resubscribe a session. Use when you need to re-enable notifications or tracking for a previously unsubscribed session.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sessionId` | string | Yes | Identifier of the session to resubscribe |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search for sessions

**Slug:** `GLEAP_SEARCH_FOR_SESSIONS`

Search for sessions in Gleap using various filter criteria. Use when you need to find sessions by user ID, email, name, or other session attributes. Supports filtering by multiple criteria including user information (userId, email, name), session identifiers (gleapId, gleapHash), language, and user status (blocked, unsubscribed).

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Filter sessions by language code (e.g., 'en', 'de', 'fr'). Use to find sessions in a specific language. |
| `name` | string | No | Filter sessions by user name. Searches for sessions where the user's name matches this value. |
| `email` | string | No | Filter sessions by user email address. Use to find sessions associated with a specific email. |
| `userId` | string | No | Filter sessions by user ID. Use to find all sessions for a specific user. |
| `blocked` | boolean | No | Filter sessions by blocked status. Set to true to find blocked users, false for non-blocked users. |
| `gleapId` | string | No | Filter by unique Gleap session identifier. Use to find a specific session by its Gleap ID. |
| `gleapHash` | string | No | Filter by Gleap session hash. Use to find sessions by their hash value. |
| `unsubscribed` | boolean | No | Filter sessions by unsubscribed status. Set to true to find unsubscribed users, false for subscribed users. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search messages

**Slug:** `GLEAP_SEARCH_MESSAGES`

Search messages in Gleap by search term. Use when you need to find specific messages based on content, keywords, or metadata across all conversations and tickets.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `searchTerm` | string | Yes | The search term to query messages. Required parameter for filtering messages by content or metadata. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Search sessions by index

**Slug:** `GLEAP_SEARCH_SESSIONS_BY_INDEX`

Search for sessions in a project using the session search index. Use when you need to retrieve sessions for a specific project using the indexed search endpoint. This endpoint provides indexed session data including user information, activity timestamps, engagement metrics, and metadata for sessions within a specific project. The search is optimized through Gleap's session index for faster lookups.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `projectId` | string | Yes | The unique identifier of the project to search sessions in. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Engagement Email Preview

**Slug:** `GLEAP_SEND_ENGAGEMENT_EMAIL_PREVIEW`

Tool to send a preview of an engagement email to specified email addresses. Use when you need to test or review how an engagement email will appear before sending it to the actual recipients.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `lang` | string | No | Language code for the email preview (e.g., 'en', 'de', 'fr'). If not specified, uses the default language |
| `emails` | array | Yes | List of email addresses to send the preview to. Must contain at least one valid email address |
| `engagementEmailId` | string | Yes | Unique identifier of the engagement email to preview. Must be a valid 24-character MongoDB ObjectId (hexadecimal string) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send ticket transcript

**Slug:** `GLEAP_SEND_TICKET_TRANSCRIPT`

Tool to send ticket conversation transcript to multiple email addresses. Use when you need to share the complete conversation history of a ticket with external users or team members via email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | List of email addresses to send the ticket conversation transcript to. Each email must be a valid email address. |
| `ticketId` | string | Yes | The unique identifier (ID) of the ticket whose transcript should be sent. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Snooze a Ticket

**Slug:** `GLEAP_SNOOZE_A_TICKET`

Tool to snooze a ticket for a specified duration. Use when you need to temporarily hide a ticket from active view. The ticket will be automatically unsnoozed after the duration expires.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `duration` | number | Yes | Duration in seconds to snooze the ticket. After this time, the ticket will be automatically unsnoozed. |
| `ticketId` | string | Yes | Identifier of the ticket to snooze |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Suggest FAQ from message

**Slug:** `GLEAP_SUGGEST_FAQ_FROM_MESSAGE`

Tool to suggest a FAQ from a message. Use when you want to accept or reject a FAQ suggestion for a specific message.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `accept` | boolean | Yes | Whether to accept the FAQ suggestion. Set to true to accept the FAQ suggestion or false to reject it. |
| `messageId` | string | Yes | Unique identifier of the message to suggest a FAQ for. Must be a valid message ID from the Gleap project. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Toggle Collection Publish Status

**Slug:** `GLEAP_TOGGLE_HELPCENTER_COLLECTION_PUBLISH`

Tool to toggle the publish status of a help center collection. Use when you need to publish or unpublish a collection to control its visibility in the help center.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `unpublished` | boolean | Yes | Whether to unpublish the collection. Set to true to unpublish (hide) the collection, or false to publish (show) it |
| `helpcenterCollectionId` | string | Yes | Unique identifier of the help center collection to toggle publish status |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Track events

**Slug:** `GLEAP_TRACK_EVENTS`

Track custom user events in Gleap for analytics and user behavior monitoring. Use this action to: - Record user actions like button clicks, page views, feature usage - Log business events like purchases, subscriptions, or conversions - Send batch events for efficiency (supports multiple events per request) - Track events with custom metadata for detailed analytics Note: Users must be identified first using the Identify User action before tracking events for them. Rate limit: 1000 requests per 60 seconds per project.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `events` | array | Yes | Array of event objects to track. Must contain at least one event. Use this to batch multiple events in a single API call for efficiency. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unarchive a Ticket

**Slug:** `GLEAP_UNARCHIVE_A_TICKET`

Tool to unarchive a ticket. Use when you need to restore a previously archived ticket after validation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticketId` | string | Yes | Identifier of the ticket to unarchive |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unlink a Ticket

**Slug:** `GLEAP_UNLINK_A_TICKET`

Tool to unlink a ticket. Use after confirming both tickets are linked to remove their association.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ticketId` | string | Yes | ID of the source ticket to unlink from |
| `targetTicketId` | string | Yes | ID of the target ticket that was previously linked |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Unsubscribe sessions

**Slug:** `GLEAP_UNSUBSCRIBE_SESSIONS`

Tool to unsubscribe one or more user sessions from communications. Use when users request to stop receiving messages or notifications.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string | No | Optional reason for unsubscribing the sessions. Helps track why users were unsubscribed. |
| `sessions` | array | Yes | List of sessions to unsubscribe. Each session must include either an email or userId. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update AI Content by Content ID

**Slug:** `GLEAP_UPDATE_AI_CONTENT_BY_CONTENT_ID`

Tool to update AI content by content ID. Use when modifying existing AI-powered content entries in Gleap.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string | Yes | Type of the AI content (e.g., 'text', 'html', 'markdown') |
| `title` | string | Yes | Title of the AI content |
| `batchId` | string | No | Batch identifier for grouping multiple AI content updates together |
| `content` | string | Yes | Content body for AI processing |
| `contentId` | string | Yes | ID of the AI content to update |
| `readMoreUrl` | string | No | URL for additional information related to this AI content |
| `readMoreLabel` | string | No | Label text for the 'read more' link |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a team

**Slug:** `GLEAP_UPDATE_A_TEAM`

Tool to update an existing team. Use when you need to modify team properties like name, assignment method, or members. All fields except the team ID are required in the request body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the team |
| `teamId` | string | Yes | The unique identifier (ID) of the team to update. This is a 24-character hexadecimal string (MongoDB ObjectId format). |
| `members` | array | Yes | List of user IDs to include in the team |
| `ticketAmount` | number | No | Maximum number of tickets when limit_ticket_amount is enabled |
| `needQueueRerun` | boolean | No | Whether the ticket queue needs to be rerun after this update |
| `assignmentMethod` | string ("random" | "balanced" | "manual" | "circular") | Yes | Method used to assign tickets within the team. 'random' assigns tickets randomly, 'balanced' distributes evenly across members, 'manual' requires manual assignment, and 'circular' rotates through members in order |
| `limitTicketAmount` | boolean | No | Whether to limit the number of tickets that can be assigned to this team |
| `selectOnlyOnlineMembers` | boolean | No | Whether to only consider online members for ticket assignments |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a ticket

**Slug:** `GLEAP_UPDATE_A_TICKET`

Tool to update an existing ticket/bug in Gleap. Use when you need to modify ticket properties like status, priority, description, type, assigned user, tags, or other attributes. All fields except the ticket ID are optional - only provide the fields you want to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier (ID) of the ticket to update. This is a 24-character hexadecimal string. |
| `tags` | array | No | Array of tag strings for categorizing and organizing tickets. Updates the ticket tags. |
| `type` | string | No | Type of ticket (e.g., BUG, INQUIRY, FEATURE_REQUEST, CRASH). Updates the ticket type. |
| `status` | string | No | Status of the ticket (e.g., OPEN, INPROGRESS, TOTEST, DONE). Updates the current status of the ticket. |
| `dueDate` | string | No | Due date for ticket resolution in ISO 8601 format (e.g., '2026-02-15T10:00:00Z'). Updates the due date. |
| `snoozed` | boolean | No | Whether the ticket is snoozed. Set to true to snooze or false to unsnooze. |
| `archived` | boolean | No | Whether the ticket is archived. Set to true to archive or false to unarchive. |
| `lexorank` | string | No | Lexorank position for ticket ordering. Used for custom sorting in kanban boards. |
| `outbound` | string | No | Outbound reference or identifier. Updates the outbound field. |
| `priority` | string | No | Priority level: 'LOW', 'MEDIUM', or 'HIGH'. Updates the priority of the ticket. |
| `description` | string | No | Detailed description of the ticket/bug. Updates the description text. |
| `duplicateOf` | string | No | ID of the ticket this is a duplicate of. Updates the duplicate reference. |
| `screenshotUrl` | string | No | URL to a screenshot associated with the ticket. Updates the screenshot URL. |
| `processingUser` | string | No | User ID assigned to process the ticket. Updates the assigned user. |
| `screenshotBroke` | string | No | Date when the screenshot broke in ISO 8601 format. Updates the screenshot broke date. |
| `notificationsUnread` | boolean | No | Whether there are unread notifications for this ticket. Updates the notification status. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a User for a Project

**Slug:** `GLEAP_UPDATE_A_USER_FOR_A_PROJECT`

Tool to update a user’s role in a project. Use when you need to change a user's permissions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string | Yes | The new role to assign to the user (e.g., 'admin', 'member') |
| `user_id` | string | Yes | The unique identifier of the user to update in the project |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Chat Message

**Slug:** `GLEAP_UPDATE_CHAT_MESSAGE`

Updates an existing chat message in Gleap by its ID. This action modifies one or more fields of a chat message such as content, status, visibility, and other properties. Use this after creating a chat message to edit its text, change its status from draft to active, or update other metadata. The message ID must be obtained from a prior create or list operation. Common use cases: - Edit message content after sending - Change message status (draft → active) - Toggle message visibility (hidden/shown) - Update message metadata (name, sound settings)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | object | Yes | JSON object containing the fields to update. Common fields include: - content (str): The message text content - status (str): Message status (e.g., 'draft', 'active') - hidden (bool): Whether the message is hidden - sound (bool): Whether to play sound - name (str): Display name/title for the message Example: {'content': 'Updated message', 'status': 'active'} |
| `chatMessageId` | string | Yes | The unique MongoDB ObjectId of the chat message to update (24-character hex string) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a Checklist

**Slug:** `GLEAP_UPDATE_CHECKLIST`

Tool to update an engagement checklist by its ID. Use to modify checklist properties such as name, description, status, items, and other configuration options.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the checklist |
| `items` | array | No | Checklist items |
| `sound` | boolean | No | Whether sound is enabled |
| `steps` | array | No | Steps in the checklist |
| `title` | string | No | Title of the checklist |
| `format` | string | No | Format of the checklist (e.g., 'widget') |
| `hidden` | boolean | No | Whether the checklist is hidden |
| `status` | string | No | Status of the checklist (e.g., 'draft', 'active') |
| `frequency` | string | No | Frequency of the checklist |
| `checklistId` | string | Yes | Unique identifier of the checklist to update |
| `description` | string | No | Description of the checklist |
| `targetAudience` | string | No | Target audience for the checklist |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement Banner

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_BANNER`

Tool to update an engagement banner. Use when modifying banner properties like name, status, targeting, or scheduling.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the banner |
| `type` | string | No | Type of engagement (e.g., BANNER) |
| `sound` | boolean | No | Whether sound is enabled |
| `format` | string | No | Display format (e.g., widget) |
| `hidden` | boolean | No | Whether the banner is hidden |
| `status` | string | No | Status of the banner (e.g., draft, active) |
| `bannerId` | string | Yes | Unique identifier of the banner to update |
| `frequency` | string | No | Frequency setting (e.g., once) |
| `newTrigger` | boolean | No | Whether this is a new trigger |
| `frequencyDays` | integer | No | Number of days for frequency |
| `frequencyType` | string | No | Type of frequency (e.g., dynamic) |
| `pageFilterType` | string | No | Type of page filter (e.g., contains) |
| `targetAudience` | string | No | Target audience (e.g., all) |
| `stopSendingAfter` | string | No | Stop sending after this date/time in ISO 8601 format |
| `startSendingAfter` | string | No | Start sending after this date/time in ISO 8601 format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement Cobrowse

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_COBROWSE`

Tool to update an existing cobrowse product tour. Use when you need to modify properties like name, description, status, or configuration of an interactive guided tour.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the cobrowse product tour |
| `type` | string ("TOUR") | No | Type of engagement, typically 'TOUR' |
| `sound` | boolean | No | Whether sound is enabled for the tour |
| `config` | object | No | Configuration object for cobrowse type |
| `format` | string ("widget") | No | Display format |
| `hidden` | boolean | No | Whether the tour is hidden from users |
| `status` | string ("draft" | "active" | "paused") | No | Status of the tour |
| `frequency` | string ("once") | No | How often to show |
| `description` | string | No | Description of the cobrowse product tour |
| `frequencyType` | string ("dynamic") | No | Frequency type |
| `pageFilterType` | string ("contains") | No | Page filter type |
| `targetAudience` | string ("all") | No | Target audience selection |
| `cobrowseProductTourId` | string | Yes | Unique identifier of the cobrowse product tour to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement Email

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_EMAIL`

Tool to update an existing engagement email. Use when you need to modify properties like name, subject, content, status, or targeting settings of an email campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the engagement email |
| `type` | string | No | Type of engagement, typically 'EMAIL' |
| `format` | string | No | Display format of the email |
| `status` | string | No | Status of the email (e.g., draft, active, paused) |
| `content` | string | No | Content body of the email (HTML or plain text) |
| `subject` | string | No | Subject line of the email |
| `frequency` | string | No | How often the email is sent (e.g., once, daily, weekly) |
| `frequencyDays` | integer | No | Number of days for frequency calculation |
| `frequencyType` | string | No | Frequency type for sending the email (e.g., dynamic, static) |
| `pageFilterType` | string | No | Type of page filtering applied |
| `targetAudience` | string | No | Target audience for the email (e.g., all, specific) |
| `stopSendingAfter` | string | No | Stop sending after this date/time in ISO 8601 format |
| `engagementEmailId` | string | Yes | Unique identifier of the engagement email to update |
| `startSendingAfter` | string | No | Start sending after this date/time in ISO 8601 format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement Modal

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_MODAL`

Tool to update an existing engagement modal. Use when you need to modify properties like name, status, format, or targeting configuration of a modal dialog.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the modal |
| `type` | string ("MODAL") | No | Type of engagement, typically 'MODAL' |
| `sound` | boolean | No | Whether sound is enabled for the modal |
| `format` | string ("widget") | No | Display format |
| `hidden` | boolean | No | Whether the modal is hidden from users |
| `status` | string ("DRAFT" | "ACTIVE" | "PAUSED") | No | Status of the modal |
| `modalId` | string | Yes | Unique identifier of the modal to update |
| `frequency` | string | No | How often the modal is shown (e.g., once) |
| `frequencyDays` | integer | No | Number of days for frequency calculation |
| `frequencyType` | string | No | Frequency type for displaying the modal (e.g., dynamic) |
| `pageFilterType` | string | No | Type of page filtering applied (e.g., contains) |
| `targetAudience` | string | No | Target audience for the modal (e.g., all) |
| `stopSendingAfter` | string | No | ISO 8601 timestamp when to stop sending the modal |
| `startSendingAfter` | string | No | ISO 8601 timestamp when to start sending the modal |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement News

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_NEWS`

Tool to update an engagement news article. Use when modifying news article properties like name, status, scheduling, targeting, or other attributes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the news article |
| `sent` | boolean | No | Whether the news has been sent |
| `type` | string | No | Type of engagement (e.g., NEWS) |
| `sound` | boolean | No | Whether to play sound |
| `format` | string | No | Format of the news article display (e.g., BANNER) |
| `hidden` | boolean | No | Whether the news is hidden |
| `newsId` | string | Yes | The unique identifier (ObjectId) of the news article to update. Must be a valid news ID from the project's engagement news list. |
| `status` | string | No | Status of the news article (e.g., DRAFT, PUBLISHED) |
| `frequency` | string | No | Frequency of display (e.g., ONCE) |
| `newTrigger` | boolean | No | Whether to use new trigger |
| `pageFilter` | string | No | Page URL or pattern to filter |
| `frequencyDays` | integer | No | Number of days for frequency |
| `frequencyType` | string | No | Type of frequency |
| `pageFilterType` | string ("is" | "isnot" | "contains" | "notcontains" | "startswith" | "endswith" | "empty" | "notempty") | No | Enum for page filter types. |
| `targetAudience` | string | No | Target audience for the news article |
| `stopSendingAfter` | string | No | End date for displaying the news in ISO 8601 format |
| `startSendingAfter` | string | No | Start date for displaying the news in ISO 8601 format |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement Product Tour

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_PRODUCT_TOUR`

Tool to update an existing product tour. Use when you need to modify properties like name, status, configuration, or targeting of a product tour.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the product tour |
| `type` | string | No | Type of engagement (e.g., TOUR) |
| `sound` | boolean | No | Whether sound is enabled |
| `config` | object | No | Configuration object for the product tour |
| `format` | string | No | Format of the product tour (e.g., widget) |
| `hidden` | boolean | No | Whether the tour is hidden |
| `status` | string ("draft" | "published") | No | Status of the product tour |
| `frequency` | string | No | Frequency setting (e.g., once) |
| `newTrigger` | boolean | No | Whether new trigger is enabled |
| `frequencyDays` | integer | No | Number of days for frequency |
| `frequencyType` | string | No | Type of frequency (e.g., dynamic) |
| `productTourId` | string | Yes | Unique identifier of the product tour to update |
| `pageFilterType` | string | No | Page filter type (e.g., contains) |
| `targetAudience` | string | No | Target audience (e.g., all) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement Push Notification

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_PUSH_NOTIFICATION`

Tool to update an existing push notification. Use when you need to modify properties like title, message, status, targeting, or scheduling of a push notification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the push notification |
| `type` | string | No | Type of engagement (e.g., PUSH) |
| `sound` | boolean | No | Whether to play sound with the push notification |
| `title` | string | No | Title of the push notification |
| `format` | string | No | Display format of the notification (e.g., widget) |
| `hidden` | boolean | No | Whether the notification is hidden |
| `status` | string | No | Status of the push notification (e.g., draft, active) |
| `message` | string | No | Message content of the push notification |
| `frequency` | string | No | Frequency of the notification (e.g., once) |
| `frequencyDays` | integer | No | Number of days for frequency calculation |
| `frequencyType` | string | No | Type of frequency (e.g., dynamic) |
| `pageFilterType` | string | No | Type of page filter (e.g., contains) |
| `targetAudience` | string | No | Target audience (e.g., all) |
| `stopSendingAfter` | string | No | Stop sending after this date/time in ISO 8601 format |
| `startSendingAfter` | string | No | Start sending after this date/time in ISO 8601 format |
| `pushNotificationId` | string | Yes | Unique identifier of the push notification to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement Survey

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_SURVEYS`

Tool to update an existing engagement survey in Gleap. Use when you need to modify survey properties like name, status, type, format, frequency settings, or targeting. Only the surveyId is required; all other fields are optional - provide only the fields you want to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the survey |
| `type` | string | No | Type of engagement element (e.g., SURVEY) |
| `sound` | boolean | No | Whether sound is enabled for the survey |
| `format` | string | No | Display format of the survey (e.g., widget) |
| `hidden` | boolean | No | Whether the survey is hidden |
| `status` | string | No | Status of the survey (e.g., draft, active) |
| `surveyId` | string | Yes | Unique identifier of the survey to update (24-character hexadecimal string) |
| `frequency` | string | No | Frequency setting for displaying the survey (e.g., once) |
| `newTrigger` | boolean | No | Whether a new trigger is enabled |
| `frequencyDays` | integer | No | Number of days for frequency configuration |
| `frequencyType` | string | No | Frequency type configuration (e.g., dynamic) |
| `pageFilterType` | string | No | Page filter type configuration (e.g., contains) |
| `targetAudience` | string | No | Target audience configuration (e.g., all, authenticated) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement Tooltips

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_TOOLTIPS`

Tool to update an engagement tooltip. Use when modifying tooltip properties like name, active status, targeting, or frequency settings.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the tooltip |
| `type` | string | No | Type of engagement (typically auto-set to TOOLTIP) |
| `sound` | boolean | No | Whether sound is enabled |
| `active` | boolean | No | Whether the tooltip is active |
| `format` | string | No | Display format (e.g., widget) |
| `hidden` | boolean | No | Whether the tooltip is hidden |
| `status` | string | No | Status of the tooltip (e.g., draft, active) |
| `frequency` | string | No | Frequency setting (e.g., once) |
| `tooltipId` | string | Yes | Unique identifier of the tooltip to update. Must be a valid tooltip ID from the project's engagement tooltips list. |
| `frequencyDays` | integer | No | Number of days for frequency |
| `frequencyType` | string | No | Type of frequency (e.g., dynamic) |
| `pageFilterType` | string | No | Type of page filter (e.g., contains) |
| `targetAudience` | string | No | Target audience (e.g., all) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Engagement WhatsApp Message

**Slug:** `GLEAP_UPDATE_ENGAGEMENT_WHATSAPP_MESSAGE`

Tool to update an existing engagement WhatsApp message. Use when you need to modify properties like name, status, or targeting settings of a WhatsApp message campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Name of the WhatsApp message |
| `type` | string | No | Type of engagement, typically 'WHATSAPP' |
| `sound` | boolean | No | Whether sound notification is enabled |
| `format` | string | No | Display format of the message |
| `hidden` | boolean | No | Whether the message is hidden |
| `status` | string | No | Status of the message (e.g., draft, active) |
| `frequency` | string | No | How often the message is sent (e.g., once, daily, weekly) |
| `newTrigger` | boolean | No | Whether this creates a new trigger |
| `frequencyDays` | integer | No | Number of days for frequency calculation |
| `frequencyType` | string | No | Frequency type for sending the message (e.g., dynamic, static) |
| `pageFilterType` | string | No | Type of page filtering applied |
| `targetAudience` | string | No | Target audience for the message (e.g., all, specific) |
| `stopSendingAfter` | string | No | Stop sending after this date/time in ISO 8601 format |
| `startSendingAfter` | string | No | Start sending after this date/time in ISO 8601 format |
| `whatsappMessageId` | string | Yes | Unique identifier of the WhatsApp message to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Helpcenter Collection

**Slug:** `GLEAP_UPDATE_HELPCENTER_COLLECTION`

Tool to update a help center collection. Use when you need to modify an existing collection's properties such as title, description, icon, audience filters, or organizational structure. All fields except the collection ID are optional - only provide the fields you want to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `docId` | integer | No | Numeric document ID this collection belongs to, if applicable |
| `title` | string | No | Title of the help center collection |
| `parent` | string | No | Identifier of the parent collection for nesting |
| `iconUrl` | string | No | URL to an icon representing the collection |
| `project` | string | No | Project ID the collection belongs to |
| `lexorank` | string | No | String used to order this collection among its peers |
| `externalId` | string | No | External identifier for syncing with other systems |
| `description` | string | No | Detailed description of the collection |
| `targetAudience` | string | No | Audience for this collection (e.g., 'all') |
| `baseAudienceFilter` | object | No | Base filter criteria object to limit the audience |
| `extendedAudienceFilter` | object | No | Additional filter criteria to extend the base audience |
| `helpcenterCollectionId` | string | Yes | ID of the help center collection to update |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update help center redirect

**Slug:** `GLEAP_UPDATE_HELPCENTER_REDIRECT`

Tool to update an existing help center redirect. Use when you need to modify the URL paths or match type of an existing redirect rule. This allows you to change where old URLs redirect to or update the matching strategy.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `newUrl` | string | Yes | The new URL path to redirect to. This is the destination URL for the redirect. |
| `oldUrl` | string | Yes | The old URL path to redirect from. This is the source URL that should be matched. |
| `matchType` | string ("exact" | "pattern") | Yes | The type of URL matching to use. 'exact' for exact URL match, 'pattern' for pattern-based matching. |
| `redirectId` | string | Yes | The unique identifier of the redirect to update. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update message template

**Slug:** `GLEAP_UPDATE_MESSAGE_TEMPLATE`

Tool to update an existing message template in Gleap. Use when you need to modify template properties like title, content, ordering, visibility, or associated actions. All fields except the template ID, title, content, and lexorank are optional.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `title` | string | Yes | Title of the message template |
| `users` | array | No | Array of user IDs who have access to this template. Only applicable when isPublic is false. |
| `actions` | array | No | Array of action items for the template (e.g., buttons, links) |
| `content` | string | Yes | Content of the message template. Can be plain text, HTML, or structured data depending on template type. |
| `isPublic` | boolean | No | Whether the template is publicly accessible. Set to true for public templates or false for restricted access. |
| `lexorank` | string | Yes | Lexorank position for template ordering. Used for custom sorting in template lists. |
| `attachments` | array | No | Array of attachment objects associated with the template |
| `messageTemplateId` | string | Yes | Unique identifier of the message template to update. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update project

**Slug:** `GLEAP_UPDATE_PROJECT`

Tool to update a Gleap project's configuration including name, description, notification settings, and feedback tags. Use when you need to modify project settings such as enabling/disabling notifications, updating contact information, or managing feedback categories. Rate limit: 1000 requests per minute.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the project to update. This is a 24-character hexadecimal string. |
| `name` | string | No | Project name to update |
| `picture` | string | No | URL of the project picture/logo |
| `description` | string | No | Project description to update |
| `phoneNumber` | string | No | Contact phone number for the project |
| `feedbackTags` | array | No | Array of feedback tags with label and color properties for categorizing feedback |
| `sendBugNotifications` | boolean | No | Enable or disable general bug notifications. When true, team members receive notifications for bug-related events. |
| `secureSessionIdentify` | boolean | No | Enable or disable secure session identification. When true, additional security measures are applied to session identification. |
| `bugNotificationsReciever` | string | No | Email address or user identifier to receive bug notifications |
| `hideDetailTabsOnSharedBugs` | boolean | No | Enable or disable hiding detail tabs on shared bugs. When true, detail tabs are hidden when bugs are shared externally. |
| `sendBugAssignmentNotifications` | boolean | No | Enable or disable bug assignment notifications. When true, team members receive notifications when bugs are assigned to them. |
| `sendFeedbackReceivedNotifications` | boolean | No | Enable or disable feedback received notifications. When true, team members receive notifications when new feedback is received. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update QA Answer

**Slug:** `GLEAP_UPDATE_QA_ANSWER`

Updates an existing QA answer/snippet in Gleap. Use when you need to modify the question, answer, tags, or other properties of a snippet. Only the fields you provide will be updated; omitted fields remain unchanged.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Tags for categorizing the snippet. Provide to update tags. |
| `answer` | string | No | The answer text for the snippet. Provide this to update the answer. |
| `skipped` | boolean | No | Whether the snippet is skipped. Set to true to mark as skipped. |
| `question` | string | No | The question text for the snippet. Provide this to update the question. |
| `projectId` | string | Yes | The unique identifier of the project containing the QA answer |
| `qaAnswerId` | string | Yes | The unique identifier of the QA answer/snippet to update |
| `acknowledged` | boolean | No | Whether the snippet is acknowledged. Set to true to mark as acknowledged. |
| `preventChunking` | boolean | No | Whether to prevent chunking of this snippet in AI processing. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update a session

**Slug:** `GLEAP_UPDATE_SESSION`

Tool to update an existing session in Gleap. Use when you need to modify session properties like user information (name, email, phone), custom data, tags, or other session attributes. All fields except the session ID are optional - only provide the fields you want to update.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sla` | number | No | Service level agreement value. |
| `lang` | string | No | Language code (e.g., 'en', 'de', 'fr'). |
| `name` | string | No | User's full name. |
| `plan` | string | No | Subscription plan. |
| `tags` | array | No | Array of tag strings for categorizing and organizing sessions. |
| `email` | string | No | User's email address. |
| `phone` | string | No | User's phone number. |
| `value` | number | No | Monetary or lifetime value associated with the user. |
| `avatar` | string | No | URL to user avatar image. |
| `userId` | string | No | User identifier for the session. |
| `blocked` | boolean | No | Whether the user is blocked. |
| `gleapId` | string | No | Unique Gleap session identifier. |
| `project` | string | No | Project ID. |
| `platform` | string | No | Platform (e.g., web, ios, android). |
| `sessions` | number | No | Number of sessions. |
| `companyId` | string | No | Company identifier. |
| `emailOnly` | boolean | No | Whether user is email-only. |
| `gleapHash` | string | No | Hash of the Gleap session. |
| `customData` | object | No | Custom metadata attached to the session (key-value pairs). |
| `deviceType` | string | No | Device type (e.g., mobile, desktop, tablet). |
| `facebookId` | string | No | Facebook ID. |
| `session_id` | string | Yes | The unique identifier (ID) of the session to update. This is a 24-character hexadecimal string. |
| `companyName` | string | No | Company name. |
| `instagramId` | string | No | Instagram ID. |
| `organisation` | string | No | Organisation ID. |
| `unsubscribed` | boolean | No | Whether user is unsubscribed. |
| `instagramUsername` | string | No | Instagram username. |
| `unsubscribeReason` | string | No | Reason for unsubscription. |
| `countFeedbackReports` | number | No | Count of feedback reports. |
| `countFeedbackComments` | number | No | Count of feedback comments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update user

**Slug:** `GLEAP_UPDATE_USER`

Tool to update a user's profile information including name, availability, profile image, onboarding status, and notification settings. Use when you need to modify user profile data or preferences. Use 'me' as the user_id to update the authenticated user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | The unique identifier of the user to update. Use 'me' to update the authenticated user's profile. |
| `lastName` | string | No | User's last name. Updates the last name field. |
| `userRole` | string | No | The user's role designation. Updates the role field. |
| `available` | boolean | No | Whether the user is currently available. Set to true for available or false for unavailable. |
| `firstName` | string | No | User's first name. Updates the first name field. |
| `userUsage` | string | No | Description of how the user intends to use Gleap. Updates the usage field. |
| `oldpassword` | string | No | Current password (required when changing password). Must be provided along with new password in notification settings. |
| `knewGleapFrom` | string | No | How the user found out about Gleap. Updates the referral source. |
| `profileImageUrl` | string | No | URL to the user's profile image. Updates the profile picture. |
| `completedOnboarding` | boolean | No | Whether the user has completed onboarding. Set to true when onboarding is complete. |
| `unavailableProjects` | array | No | List of project IDs where the user is marked as unavailable. Updates the unavailable projects list. |
| `notificationSettings` | object | No | Notification settings object containing global notification configuration. Updates the notification settings. |
| `notificationPreferences` | object | No | Notification preferences object containing settings for different notification types (e.g., {'personal-ticket-messages': {'push': true, 'email': false}}). Updates the notification preferences. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Vote for ticket

**Slug:** `GLEAP_VOTE_FOR_TICKET`

Tool to vote for a ticket in Gleap. Use when users want to upvote or show support for a specific ticket or feature request. Each email can only vote once per ticket to prevent duplicate votes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the user casting the vote. Used to track votes and prevent duplicate voting. |
| `ticketId` | string | Yes | The unique identifier (ID) of the ticket to vote for. This is a 24-character hexadecimal string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |