# Mixmax The #1 Sales Engagement Platform for Gmail. Mixmax provides email tracking, scheduling, sequences, and productivity tools for sales teams. - **Category:** email - **Auth:** API_KEY - **Composio Managed App Available?** N/A - **Tools:** 95 - **Triggers:** 0 - **Slug:** `MIXMAX` - **Version:** 20260312_00 ## Tools ### Add Contact to Group **Slug:** `MIXMAX_ADD_CONTACT_TO_GROUP` Tool to add a contact to a contact group. Use when you need to add a single contact or bulk add multiple contacts (up to 100) to a specific group. Either email or contactId must be provided for each contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The _id of the Contact Group the Contact will be added to. | | `meta` | object | No | Contact variables from any source (ex. Salesforce) that are used to populate sequences and templates. Anything passed here will be merged with an existing contact's meta, if one exists for the same email. | | `name` | string | No | Name of the contact to add. | | `email` | string | No | Email of the contact to add. Resolves the email to a contact owned by the user. Required if contactId not provided and contacts array is empty. | | `contacts` | array | No | For bulk adding recipients. Max 100 entries. Each entry must have either email or contactId field. | | `contactId` | string | No | The id of the contact to add to the group. Required if email not provided and contacts array is empty. | #### 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 | ### Add Email to Unsubscribe List **Slug:** `MIXMAX_ADD_EMAIL_TO_UNSUBSCRIBE_LIST` Tool to add an email address to the Mixmax unsubscribe list. Use when you need to prevent sending emails to a specific address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | The email address to add to the unsubscribe 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 | ### Add Snippet to Tag **Slug:** `MIXMAX_ADD_SNIPPET_TO_TAG` Tool to add a snippet to a snippet tag in Mixmax. Use when you need to organize snippets by adding them to specific tags or folders. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The snippet tag ID to add the snippet to | | `snippetId` | string | Yes | The ID of the snippet to add to the tag | #### 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 | ### Add Team Members **Slug:** `MIXMAX_ADD_TEAM_MEMBERS` Tool to add one or more members to a Mixmax team by email. Use when you need to invite new members to a team. Returns the complete list of all team members after the addition. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the team to add members to | | `members` | array | Yes | Array of member objects to add to the team. Each object must contain an email address. | #### 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 | ### Cancel Sequence Recipients **Slug:** `MIXMAX_CANCEL_SEQUENCES` Tool to cancel specific recipients across all sequences. Use when you need to remove recipients from all active sequences. If emails parameter is provided, only those recipients are canceled; otherwise all active recipients are canceled. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `emails` | array | No | Email addresses of specific recipients to cancel from all sequences. When omitted, all active recipients across all sequences are canceled. | #### 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 Code Snippet **Slug:** `MIXMAX_CREATE_CODE_SNIPPET` Tool to create a new Formatted Code enhancement in Mixmax. Use when you need to save a code snippet that can be recalled using /code command in the UI. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `html` | string | Yes | The HTML of your code snippet. This is what appears in the editor. | | `theme` | string | No | The code editor theme for syntax highlighting. | | `title` | string | No | The title of the code snippet. | | `language` | string | No | The programming language your code is written in (for syntax highlighting). | | `background` | string | No | Background color in RGB format. Must be of format rgb(0-255, 0-255, 0-255). | #### 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 Contact **Slug:** `MIXMAX_CREATE_CONTACT` Tool to create a new contact in Mixmax. Use when you need to add a new contact with an email address and optional metadata. If a contact with the same email already exists, it will be merged. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `meta` | object | No | Contact variables from any source (ex. Salesforce) that are used to populate sequences and templates variables | | `name` | string | No | Contact's name | | `email` | string | Yes | Email address for the contact. This is unique per contact. If a contact with this email already exists, the contact will be merged. | | `enrich` | boolean | No | Merges information from third-party sources like Salesforce | | `groups` | array | No | Array of contact group IDs this contact belongs to | | `contactId` | string | No | Google Contacts ID for the same email address | | `markAsUsed` | boolean | No | Increments contact's usedCount and sets timestamp to now | | `salesforceId` | string | No | Salesforce ID if contact exists in Salesforce | #### 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 Contact Group **Slug:** `MIXMAX_CREATE_CONTACT_GROUP` Tool to create a new contact group in Mixmax. Use when you need to organize contacts into a new group for better contact management. Note: This endpoint is deprecated but still functional. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the new contact group. | | `expand` | string | No | Pass 'userId' to replace the userId with _id and name in the response. | | `contacts` | array | No | Array of contacts to add to the new group. Each contact should have an email and optionally a name. | #### 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 Contact Note **Slug:** `MIXMAX_CREATE_CONTACT_NOTE` Tool to create a note for a contact. Use when you need to add a new note to a contact by their ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The _id of the contact to add a note to. | | `text` | string | Yes | The content of the note to be created. | | `expand` | string | No | Pass expand=userId to expand the response to include the name and email of the note owner. | #### 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 insights report **Slug:** `MIXMAX_CREATE_INSIGHTS_REPORT` Tool to create a new insights report in Mixmax. Use when you need to generate analytics reports for messages, meetings, groups, users, sequences, templates, delegators, or customers. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("messages" | "meetings" | "groups" | "users" | "sequences" | "templates" | "delegators" | "customers") | No | Enum for insights report types. | | `query` | string | No | The report query to run using Mixmax query syntax. Defaults to 'sent:last30days from:everyone' if not provided. | | `title` | string | No | The title of the report. Defaults to 'Super report' if not provided. | #### 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 Integration Enhancement **Slug:** `MIXMAX_CREATE_INTEGRATION_ENHANCEMENT` Tool to create a new enhancement integration in Mixmax. Use when you need to add a custom enhancement that will appear in the Enhance menu for your account only. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `icon` | string | Yes | URL to the icon image that will be displayed in the Enhance menu | | `name` | string | Yes | The name of the enhancement that shows up in the Enhance menu | | `editorUrl` | string | Yes | URL that opens in a new browser window when the enhancement is clicked in the Enhance menu. This is where users configure the enhancement. | | `iconTooltip` | string | Yes | Tooltip text that appears when hovering over the enhancement icon in the UI | | `resolverUrl` | string | Yes | RESTful API endpoint that is called with the enhancement instance parameters to return HTML representation of the enhancement 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 | ### Create Integrations Command **Slug:** `MIXMAX_CREATE_INTEGRATIONS_COMMAND` Tool to create a new slash command that will be visible to only your account. Use when you need to add a custom slash command integration to Mixmax. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | String name of the command that shows up in the command menu | | `command` | string | Yes | Typing this string after a slash will trigger the command. Must be globally unique. Spaces not allowed. | | `commandResolverUrl` | string | Yes | URL called when the user presses enter after typing a command | | `parameterPlaceholder` | string | Yes | String parameter placeholder text that shows up in the command menu | | `commandParameterHintsUrl` | string | Yes | URL that is called with the command text that returns an array of suggestions | #### 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 Integrations Sidebars **Slug:** `MIXMAX_CREATE_INTEGRATIONS_SIDEBARS` Tool to create a new sidebar integration in Mixmax. Use when you need to register a custom sidebar that will appear in the Mixmax interface. Note: The sidebar will be visible only to your account unless shared with support@mixmax.com. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | The URL of the integration. The webpage at this URL should use the Sidebar SDK to communicate with Mixmax | | `name` | string | Yes | The name of the sidebar integration to show up in developer settings | | `iconName` | string | No | Icon name identifier (e.g., 'star'). Required if iconImage is not provided, must be used with iconColor | | `iconColor` | string | No | Icon color in hex format (e.g., '#0000FF'). Required if iconImage is not provided, must be used with iconName | | `iconImage` | string | No | Icon image URL. Either iconImage, or both iconName and iconColor must be provided | #### 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 Link Resolver **Slug:** `MIXMAX_CREATE_LINK_RESOLVER` Tool to create a new link resolver integration in Mixmax. Use when you need to set up automatic URL resolution for specific URL patterns. Note that 'shared' link resolvers cannot be created using this endpoint - the enhancement will be visible only to your account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Arbitrary name for the link resolver to identify it in your integrations. | | `regex` | string | Yes | Regular expression to match the URL pattern. Must not permit spaces. This regex is passed to JavaScript RegExp() constructor, so use JavaScript regex syntax. | | `description` | string | Yes | Description of what the link resolver does and what URL patterns it handles. | | `resolverUrl` | string | Yes | The URL (webhook endpoint) that will be called when a user pastes a matching URL. Called via HTTP GET with querystring parameters containing the matched URL. | #### 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 Livefeed Search **Slug:** `MIXMAX_CREATE_LIVEFEED_SEARCH` Tool to create a new saved search in the Mixmax livefeed. Use when you need to save a frequently-used livefeed query for quick access later. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `query` | string | Yes | The query string that the search performs. Takes the same format as queries in the live feed UI (e.g., 'is:sent -is:replied', 'opened:>5', 'from:user@example.com') | | `title` | string | No | The title of the search. If not specified, defaults to 'Untitled 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 | ### Create Message **Slug:** `MIXMAX_CREATE_MESSAGE` Tool to create a draft Mixmax message (email). Use when you need to compose a new email draft in Mixmax. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cc` | array | No | Recipients of message in the 'cc' field. Array of objects with 'email' (required) and 'name' (optional) properties. | | `to` | array | No | Recipients of message in the 'to' field. Array of objects with 'email' (required) and 'name' (optional) properties. | | `bcc` | array | No | Recipients of message in the 'bcc' field. Array of objects with 'email' (required) and 'name' (optional) properties. | | `body` | string | No | HTML body of the message. | | `subject` | string | No | Email subject line. | | `inReplyTo` | string | No | Gmail Message ID if replying to existing message. | | `trackingEnabled` | boolean | No | Email tracking enabled (default: false). | | `userHasModified` | boolean | No | Set to true to create a Gmail draft for the message (default: false). | | `fileTrackingEnabled` | boolean | No | File/download tracking enabled (default: false). | | `linkTrackingEnabled` | boolean | No | Link tracking enabled (default: false). | | `notificationsEnabled` | boolean | No | Desktop notifications enabled (default: false). | #### 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 Rule **Slug:** `MIXMAX_CREATE_RULE` Tool to create a new Mixmax rule/webhook. Use when you need to set up event-based automation that triggers on specific events like message sent, opened, or clicked. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | The name of the rule to identify it | | `filter` | string | No | JSON string representing filter criteria for the rule. Use '{}' for no filter, or specify conditions to match events. | | `trigger` | object | Yes | Rule trigger configuration with type and eventName fields. Defines when the rule should fire. | #### 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 Rule Action **Slug:** `MIXMAX_CREATE_RULE_ACTION` Tool to create a new action for a Mixmax rule. Use when you need to add an action (such as a webhook) to an existing rule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the rule to add the action to | | `url` | string | Yes | The webhook URL endpoint for webhook-type actions | | `type` | string | Yes | The type of action to create (e.g., 'webhook') | #### 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 Sequence Folder **Slug:** `MIXMAX_CREATE_SEQUENCE_FOLDER` Tool to create a new sequence folder in Mixmax. Use when you need to organize sequences by creating a new folder to group related sequences together. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the sequence folder to create | #### 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 Snippet Tag **Slug:** `MIXMAX_CREATE_SNIPPET_TAG` Tool to create a new snippet tag (folder) in Mixmax. Use when you need to organize snippets by creating a new tag or folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Display name of the snippet tag/folder to create | #### 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 Team **Slug:** `MIXMAX_CREATE_TEAM` Tool to create a new team in Mixmax. Use when you need to create a team with a specific name. The authenticated user is automatically added as an admin member of the newly created team. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | The name of the team to create | #### 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 Contact **Slug:** `MIXMAX_DELETE_CONTACT` Tool to delete a contact by ID. Use when you need to remove a contact from Mixmax. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The MongoDB ObjectID of the contact 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 Contact Group **Slug:** `MIXMAX_DELETE_CONTACT_GROUP` Tool to delete a contact group by ID. Use when you need to remove a contact group after confirming its ID. Note: This endpoint is deprecated and returns 204 with no content on success. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The _id of the Contact Group 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 Contact Note **Slug:** `MIXMAX_DELETE_CONTACT_NOTE` Tool to delete a note from a contact by its ID. Only the creator of the note can delete it. Use when removing a note after confirming both the contact ID and note ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `note_id` | string | Yes | The _id of the note for the contact to delete. | | `contact_id` | string | Yes | The _id of the contact the note belongs to. Only the creator of the note can delete it. | #### 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 Integration Enhancement **Slug:** `MIXMAX_DELETE_INTEGRATION_ENHANCEMENT` Tool to delete an integration enhancement by its ID. Use when you need to remove an enhancement from the Mixmax platform. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the enhancement 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 slash command **Slug:** `MIXMAX_DELETE_INTEGRATIONS_COMMANDS_ID` Tool to delete a slash command by its unique ID from Mixmax integrations. Use when you need to permanently remove a slash command. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier (_id) of the slash command to delete. This is the command's ID returned when creating or listing commands. | #### 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 Integrations Sidebars **Slug:** `MIXMAX_DELETE_INTEGRATIONS_SIDEBARS` Tool to delete a sidebar integration by its ID. Use when removing an integration sidebar from Mixmax. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the sidebar integration to remove | #### 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 Link Resolver **Slug:** `MIXMAX_DELETE_LINK_RESOLVER` Tool to permanently delete a link resolver by its ID. Use when removing unwanted or obsolete link resolvers. Returns empty response on success (204 No Content). #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier (_id field) of the link resolver to delete. WARNING: This permanently deletes the link resolver. This action cannot be undone. | #### 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 Rule **Slug:** `MIXMAX_DELETE_RULE` Tool to delete a Mixmax rule by its ID. Rules are used to intercept events and route them to webhooks. Use when you need to remove a rule after confirming its ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the rule 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 Rule Action **Slug:** `MIXMAX_DELETE_RULE_ACTION` Tool to delete an action from a Mixmax rule. Use when you need to remove a specific action from an existing rule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the rule | | `actionId` | string | Yes | The ID of the action 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 Sequence Folder **Slug:** `MIXMAX_DELETE_SEQUENCE_FOLDER` Tool to permanently delete a sequence folder by its ID. Use when removing unwanted or obsolete sequence folders. Note: This endpoint returns 204 with no content on success. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the sequence folder to delete. WARNING: This permanently deletes the sequence folder. This action cannot be undone. | #### 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 Snippet **Slug:** `MIXMAX_DELETE_SNIPPET` Tool to delete a snippet by moving it to trash. The snippet remains accessible via API with deletedOnly=true query parameter for 28 days before automatic purging. Recovery is possible by moving deleted snippets back into a folder using POST /snippettags/:id/snippets. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the snippet 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 Snippet Tag **Slug:** `MIXMAX_DELETE_SNIPPET_TAG` Tool to delete a snippet tag by its unique ID. Use when you need to remove a snippet tag from Mixmax. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The identifier of the snippet tag to remove | #### 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:** `MIXMAX_DELETE_TEAM` Tool to delete a team by its ID. Disbands the team permanently. Use only when confirmed by an admin, as this action is irreversible. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the team to delete. WARNING: This action disbands the team and can only be performed by an admin. This operation is irreversible. | #### 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 Unsubscribe **Slug:** `MIXMAX_DELETE_UNSUBSCRIBE` Tool to remove an email address from the Mixmax unsubscribe list. Use when you need to re-enable email sending to a previously unsubscribed address. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | The email address to remove from the unsubscribe 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 Code Snippet **Slug:** `MIXMAX_GET_CODE_SNIPPET` Tool to fetch a single Formatted Code enhancement by its unique ID. Use when you need to retrieve detailed information about a specific code snippet. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the code snippet 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 contact by ID **Slug:** `MIXMAX_GET_CONTACT` Tool to retrieve a single contact by ID from Mixmax. Use when you need to fetch detailed information about a specific contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The _id of the contact object to retrieve | | `expand` | string | No | Fields to expand in comma separated form. Currently supporting 'firstName', 'lastName', and 'groups' | #### 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 Contact Group **Slug:** `MIXMAX_GET_CONTACT_GROUP` Tool to retrieve a single contact group by ID. Use when you need to fetch details of a specific contact group. Note: This endpoint is deprecated but still functional. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The _id of the contactgroup object 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 Contactgroup Contacts **Slug:** `MIXMAX_GET_CONTACTGROUP_CONTACTS` Tool to retrieve membership for a contact group in Mixmax. Returns a list of contacts belonging to the specified group with their email addresses, user IDs, and optionally analytics data. Use when you need to see which contacts are part of a specific group or analyze engagement metrics for group members. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The _id of the contactgroup object to fetch membership for | | `sort` | string ("name" | "email" | "timestamp" | "usedCount") | No | Sort field options for contact listing | | `dates` | string ("today" | "yesterday" | "last7" | "thisWeek" | "lastWeek" | "last30" | "thisMonth" | "lastMonth" | "last12Months" | "thisYear" | "lastYear" | "allTime" | "specific") | No | Date range options for analytics | | `since` | string | No | When dates is 'specific', the lower bound timestamp in milliseconds. Required if dates='specific'. | | `until` | string | No | When dates is 'specific', the upper bound timestamp in milliseconds. Required if dates='specific'. | | `expand` | string | No | Fields to expand in comma separated form. Currently supporting 'firstName' and 'lastName' and 'groups'. | | `sortAscending` | boolean | No | True to sort ascending (A-Z), false for descending | | `withAnalytics` | boolean | No | Include analytics in the response. When enabled, each contact will include engagement metrics like sent, opened, clicked, replied, etc. | | `timezoneOffset` | integer | No | The client's timezone offset, in minutes. Used to correctly interpret date ranges for analytics. | #### 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 Contact Notes **Slug:** `MIXMAX_GET_CONTACT_NOTES` Tool to retrieve notes associated with a specific contact. Use when you need to fetch notes for a contact by their ID. Note: This endpoint is deprecated and may be removed in future API versions. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The _id of the contact to retrieve notes for. | | `expand` | string | No | Optional comma-separated list of fields to expand with additional 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 File Requests **Slug:** `MIXMAX_GET_FILEREQUESTS` Tool to retrieve all file requests that you've sent out through Mixmax. Use when you need to see which file requests have been sent and track received uploads. #### 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 insights report by ID **Slug:** `MIXMAX_GET_INSIGHTS_REPORT_BY_ID` Tool to retrieve a single insights report by ID from Mixmax. Use when you need to fetch detailed information about a specific report including its title, query, and metadata. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier (_id) of the insights report 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 Integrations Commands **Slug:** `MIXMAX_GET_INTEGRATIONS_COMMANDS` Tool to retrieve a list of Slash Commands that you have access to in Mixmax. Use when you need to view or list all available slash command integrations. #### 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 Integrations Enhancements **Slug:** `MIXMAX_GET_INTEGRATIONS_ENHANCEMENTS` Tool to retrieve a list of enhancements that you have access to in Mixmax. Use when you need to view available integrations enhancements. #### 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 Link Resolver Integrations **Slug:** `MIXMAX_GET_INTEGRATIONS_LINKRESOLVERS` Tool to retrieve all link resolver integrations configured in Mixmax. Use when you need to list or view the link resolver integrations that transform URLs in emails. #### 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 Integrations Sidebars **Slug:** `MIXMAX_GET_INTEGRATIONS_SIDEBARS` Tool to retrieve a list of sidebar integrations that you have access to in Mixmax. Use when you need to view or list all available sidebar integrations. #### 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 live feed activity data **Slug:** `MIXMAX_GET_LIVEFEED` Tool to retrieve live feed activity data from Mixmax. Use when you need to get email engagement metrics, track message activity, or analyze send performance. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of results to return per page. Maximum 10,000. Default: 50 | | `query` | string | No | The query to execute. Takes the same format as queries in the live feed UI (e.g., 'from:user@example.com opened:>5') | | `stats` | boolean | No | Include aggregate statistics with query results (opened count, clicked count, etc.). Default: true | | `offset` | integer | No | Paging offset for pagination. Use this to retrieve subsequent pages of results. Default: 0 | | `timezone` | string | No | RFC timezone descriptor for date/time formatting (e.g., 'America/Los_Angeles'). Defaults to UTC if not specified | | `messageIds` | array | No | Restricts results to specified message IDs only. Useful for fetching specific 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 Livefeed Events **Slug:** `MIXMAX_GET_LIVEFEED_EVENTS` Tool to retrieve events for a specific message in the live feed. Use when you need to fetch interaction events (opens, clicks, replies) for a message sent through Mixmax or for all interactions with a specific contact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `messageId` | string | No | The identifier of the message to fetch events for. Either this or contactEmail must be provided. | | `contactEmail` | string | No | The email address of the contact to fetch events for. Either this or messageId must be provided. | | `includeTeammates` | boolean | No | If contactEmail is provided, whether to also include events between the contactEmail and all of your Mixmax teammates. Default: false | | `wasSentViaMixmax` | boolean | Yes | Whether the message was sent via Mixmax (true) or some other email client (false) | #### 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 Meeting Invites **Slug:** `MIXMAX_GET_MEETING_INVITES` Tool to retrieve a paginated list of meeting invites from Mixmax. Use when you need to access meeting scheduling information including timeslots, locations, and guest details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next` | string | No | Cursor string to fetch the next page of results. Obtained from a previous response. | | `limit` | integer | No | Number of meeting invites to return per page. Maximum is typically 300. | | `previous` | string | No | Cursor string to fetch the previous page of results. Used for walking pages backwards. | #### 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 by ID **Slug:** `MIXMAX_GET_MESSAGE` Tool to retrieve a single message by its unique ID. Use when you need to fetch detailed information about a specific message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique message identifier 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 Messages **Slug:** `MIXMAX_GET_MESSAGES` Tool to retrieve messages (emails) from Mixmax. Returns messages that are in draft, have been scheduled to send, or have been sent. Use when you need to list or search through emails managed by Mixmax. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next` | string | No | Pagination cursor for retrieving the next page of results. Use the value from the previous response. | | `limit` | integer | No | Maximum number of messages to return per page | #### 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 Polls **Slug:** `MIXMAX_GET_POLLS` Tool to retrieve polls created in Mixmax along with voting information. Use when you need to view polls you've sent and see who has voted on them. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next` | string | No | Cursor token for pagination. Pass the 'next' value from the previous response to fetch the next page of results. | | `limit` | integer | No | Maximum number of poll results to return per page. | #### 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 Q&A Surveys **Slug:** `MIXMAX_GET_QA` Tool to retrieve Question & Answer surveys data from Mixmax. Use when you need to fetch Q&A survey information including questions, responses, and respondent details. Results are returned with newest surveys first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Number of results to return per page. Use this to control pagination. | | `fields` | string | No | Comma-delimited list of field names to return (using dot notation for nested properties). Example: '_id,title,questions.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 Reports Data Table **Slug:** `MIXMAX_GET_REPORTS_DATA_TABLE` Tool to query analytics data for messages and meetings from Mixmax reports. Returns metrics like opens, clicks, replies, deliverability rates, and percentages. Use when you need to retrieve analytics or performance data for email campaigns or meeting activity. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `type` | string ("messages" | "meetings" | "sequences") | Yes | Data type to query. Valid values: messages (email analytics), meetings (meeting analytics), sequences (sequence analytics) | | `limit` | integer | No | Maximum number of results to return. Default: 1000, Max: 10000 | | `query` | string | No | Query filter string to narrow down results (e.g., 'sent:last30days from:everyone', 'delivered:last7days') | | `fields` | string | No | Comma-delimited list of fields to return in the response (e.g., 'delivered,opened,clicked') | | `offset` | integer | No | Pagination offset for retrieving results beyond the limit. Default: 0 | | `sortBy` | string | No | Field to sort results by. Defaults to 'sent' for messages or 'start' for meetings | | `groupBy` | string | No | Aggregation method for grouping results. For messages: delegator, customerDomain, message, recipient, emailsByDomain, sender, senderGroup, time, template. For meetings: groupmember, teammate, group | | `sortDesc` | boolean | No | Sort results in descending order. Default: true | | `timezone` | string | No | RFC timezone string for time-based data (e.g., 'America/Los_Angeles', 'Europe/London'). Default: UTC | #### 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 rules **Slug:** `MIXMAX_GET_RULES` Tool to retrieve all Mixmax rules for the authenticated user. Rules are used to intercept events and route them to webhooks or other destinations. Use when you need to list all configured rules. #### 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 Rule by ID **Slug:** `MIXMAX_GET_RULES_ID` Tool to fetch a single rule by its unique ID from Mixmax. Use when you need to retrieve detailed information about a specific rule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the rule 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 Salesforce account information **Slug:** `MIXMAX_GET_SALESFORCE_ACCOUNT` Tool to retrieve Salesforce account information for the authenticated user. Use when you need to check if a user is connected to Salesforce or fetch their Salesforce account 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 Sequence Folder by ID **Slug:** `MIXMAX_GET_SEQUENCE_FOLDER` Tool to retrieve a single sequence folder by its ID from Mixmax. Use when you need to fetch details about a specific sequence folder. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the sequence folder 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 Snippet by ID **Slug:** `MIXMAX_GET_SNIPPETS_ID` Tool to fetch a single snippet by its unique ID from Mixmax. Use when you need to retrieve detailed information about a specific snippet including its content, metadata, and sharing settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the snippet 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 Snippet Tag **Slug:** `MIXMAX_GET_SNIPPET_TAG` Tool to retrieve a single snippet tag (folder) by its unique ID. Use when you need to fetch details about a specific snippet tag. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the snippet tag 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 Snippet Tags **Slug:** `MIXMAX_GET_SNIPPET_TAGS` Tool to retrieve a list of snippet tags (folders) from Mixmax. Use when you need to view or organize snippet tags in your Mixmax account. #### 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 Team Members **Slug:** `MIXMAX_GET_TEAM_MEMBERS` Tool to retrieve all members of a Mixmax team. Use when you need to list team memberships, including member details, roles, and invitation status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the team whose members 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 Teams **Slug:** `MIXMAX_GET_TEAMS` Tool to retrieve all teams that the authenticated user is a member of. Use when you need to list or view teams in Mixmax. #### 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 Unsubscribes **Slug:** `MIXMAX_GET_UNSUBSCRIBES` Tool to retrieve a list of unsubscribed email addresses from Mixmax. Use when you need to view contacts who have unsubscribed from sequences. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next` | string | No | A cursor used to fetch the next page in the collection, for pagination. Use the value from the previous response. | | `limit` | integer | No | The number of results to return per page. Defaults to 50 if not specified. | | `fields` | string | No | A comma-delimited list of field names to return only specific fields in the response. | | `previous` | string | No | The cursor to start fetching the previous page of results. Use the value from the previous response. | #### 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 Preferences **Slug:** `MIXMAX_GET_USER_PREFERENCES_ME` Tool to retrieve preferences for the currently authenticated user. Use when you need to fetch user-specific settings and configuration options. #### 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:** `MIXMAX_GET_USERS_ME` Tool to retrieve information about the currently authenticated user. Use when you need to fetch the current user's ID and profile 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 Yes/No Questions **Slug:** `MIXMAX_GET_YES_NO` Tool to retrieve Yes/No questions created in Mixmax. Use when you need to view Yes/No questions you've sent and see who has responded to them. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `next` | string | No | Cursor token for pagination. Pass the 'next' value from the previous response to fetch the next page of results. | | `limit` | integer | No | Maximum number of Yes/No question results to return per page. | #### 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 | ### List Code Snippets **Slug:** `MIXMAX_LIST_CODE_SNIPPETS` Tool to list all Formatted Code enhancements you've created. Use when you need to retrieve code snippets available in your Mixmax account. #### 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 | ### List Contact Groups **Slug:** `MIXMAX_LIST_CONTACT_GROUPS` Tool to retrieve a list of contact groups from Mixmax. Use when you need to view, search, or sort contact groups. Supports filtering by name and sorting options. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name" | "_id") | No | Sort field options for contact groups. | | `expand` | string | No | Supports userId expansion. Specify 'userId' to expand user details. | | `search` | string | No | Partial, case-insensitive search on the group name. Use this to filter groups by name. | | `sortAscending` | boolean | No | Sort in ascending order (A-Z). Default is false (descending). | #### 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 | ### List Contacts **Slug:** `MIXMAX_LIST_CONTACTS` Tool to retrieve all Mixmax contacts (people you've emailed using Mixmax). Use when you need to list, search, or analyze contacts with optional analytics data. Note: Endpoint is deprecated but remains functional. Does not return contacts shared via contact groups unless search parameter is provided. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sort` | string ("name" | "email" | "timestamp" | "usedCount") | No | Fields to sort contacts by | | `dates` | string ("today" | "last30" | "allTime") | No | Analytics date range options | | `since` | string | No | Lower bound for specific date range filter in ISO 8601 date-time format. | | `until` | string | No | Upper bound for specific date range filter in ISO 8601 date-time format. | | `expand` | string | No | Comma-separated list of fields to expand in response: firstName, lastName, groups, notes, salesforce. | | `search` | string | No | Optional search string to filter contacts. When provided, searches across all contact fields. Also enables includeShared parameter. | | `includeShared` | boolean | No | Include contacts shared with you via shared contact groups. Requires search parameter to be provided. | | `sortAscending` | boolean | No | Sort contacts in ascending order (A-Z). Defaults to false (descending order). | | `withAnalytics` | boolean | No | Include analytics data (sent, opened, clicked metrics) in the response. | | `timezoneOffset` | integer | No | Client timezone offset in minutes for analytics date calculations. | #### 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 | ### List Rule Actions **Slug:** `MIXMAX_LIST_RULE_ACTIONS` Tool to list all actions for a given Mixmax rule. Actions represent the "Then" part of the rules UI - what happens when a rule is triggered. Use when you need to view all actions configured for a specific rule. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the rule whose actions 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 | ### List Sequence Folders **Slug:** `MIXMAX_LIST_SEQUENCE_FOLDERS` Tool to retrieve a list of all sequence folders from Mixmax. Use when you need to view or enumerate available sequence folders for organizing sequences. #### 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 | ### List Sequences **Slug:** `MIXMAX_LIST_SEQUENCES` Tool to retrieve a list of sequences from Mixmax. Use when you need to view sequences (email campaigns) that you have access to. Supports limiting results and expanding nested fields like stages and userId. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of sequences to return | | `expand` | string | No | Fields to expand in comma-separated form. Supports 'stages' and 'userId' for expanded 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 | ### List Snippets **Slug:** `MIXMAX_LIST_SNIPPETS` Tool to list templates or snippets that you have access to (including those shared with you). Use when you need to retrieve available snippets in your Mixmax account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `limit` | integer | No | Maximum number of results to return | | `deletedOnly` | boolean | No | Return only deleted templates (in trash). Deleted snippets remain accessible for 28 days before automatic purging. | #### 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 Rule by ID **Slug:** `MIXMAX_PATCH_RULES_ID` Tool to update a rule by its unique ID in Mixmax. Use when you need to modify an existing rule's name, trigger, or filter. At least one field should be provided to update. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the rule to update | | `name` | string | No | The name of the rule to update | | `filter` | string | No | JSON string filter for the rule. Must be a valid JSON string. | | `trigger` | object | No | Trigger configuration for a rule. | #### 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 Rule Action **Slug:** `MIXMAX_PATCH_RULES_ID_ACTIONS_ID` Tool to update an action within a Mixmax rule. Use when you need to modify action properties like webhook URL or action type. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The ID of the rule containing the action | | `url` | string | No | The webhook URL for webhook-type actions. Update this to change the webhook endpoint. | | `type` | string | No | The type of action (e.g., 'webhook'). Only required when changing action type. | | `actionId` | string | Yes | The ID of the action 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 Snippet by ID **Slug:** `MIXMAX_PATCH_SNIPPETS_ID` Tool to update a snippet by its unique ID in Mixmax. Use when you need to modify an existing snippet's name, title, content, or inline status. At least one field should be provided to update. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the snippet to update | | `name` | string | No | Name/label of the snippet to update | | `title` | string | No | Subject line/title for the snippet. Used as the subject line when the snippet is inserted into an email. | | `source` | string | No | HTML content of the snippet. Contains the body text that will be inserted when using the snippet. | | `isInline` | boolean | No | Whether the snippet is inline (inserted at cursor position) or standalone (replaces entire email body) | #### 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 | ### Query Contacts **Slug:** `MIXMAX_QUERY_CONTACTS` Tool to search for matching contacts across multiple sources including Mixmax, Google Directory, and Salesforce (contacts, leads, accounts, and opportunities). Use when you need to find contacts by name, email, or other search criteria. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `q` | string | Yes | The search query string to find matching contacts | | `includeSalesforceAccounts` | boolean | No | Whether to include matching Salesforce Accounts in the query results. If not specified, defaults to API's default behavior | | `includeSalesforceContacts` | boolean | No | Whether to include Salesforce Contacts and Leads in the query results. If not specified, defaults to API's default behavior | | `includeSalesforceOpportunities` | boolean | No | Whether to include matching Salesforce Opportunities in the query results. If not specified, defaults to API's default behavior | #### 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 | ### Remove Contact from Group **Slug:** `MIXMAX_REMOVE_CONTACT_FROM_GROUP` Tool to remove a contact from a contact group. Use when you need to disassociate a contact from a specific group after confirming both the group ID and contact ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the contact group | | `contactId` | string | Yes | The unique identifier of the contact to remove from the group | #### 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 | ### Remove Team Member **Slug:** `MIXMAX_REMOVE_TEAM_MEMBER` Tool to remove a member from a Mixmax team. Use when you need to revoke a user's team membership. Can only be called by the admin or a user trying to leave a team. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the team | | `member_id` | string | Yes | The unique identifier of the member to remove from the team | #### 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 Sequences **Slug:** `MIXMAX_SEARCH_SEQUENCES` Tool to search sequence recipients by email and sequenceId from Mixmax. Use when you need to find sequences and recipients based on specific criteria. Returns both sequences and recipients matching the search parameters. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | No | Email address of the sequence recipient to search for. Use this to filter sequences by recipient email. | | `sequenceId` | string | No | ID of the sequence to search within. Use this to filter recipients by a specific sequence. | #### 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 Message Draft **Slug:** `MIXMAX_SEND_MESSAGE` Tool to send a message draft by its unique ID. Use when you need to send an existing draft message that was created via POST /v1/messages. Messages are sent within 3 seconds after calling this action. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique message identifier of the draft to send. | #### 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 Snippet as Email **Slug:** `MIXMAX_SEND_SNIPPET` Tool to send a snippet as an email to specified recipients. Use when you need to send a saved snippet/template to one or more email addresses. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the snippet to send. | | `to` | array | Yes | List of recipients to send the snippet to. Each recipient must have an email address and optionally a name. | #### 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 Test Message **Slug:** `MIXMAX_SEND_TEST_MESSAGE` Tool to send a test Mixmax message to the authenticated user, resolving any variables. Use when you need to test message templates or verify that the Mixmax API integration is working correctly. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `body` | string | No | HTML-formatted message content. | | `subject` | string | No | The message subject line. | #### 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 Appointment Link Calendar Name **Slug:** `MIXMAX_UPDATE_APPOINTMENT_LINK_CALENDAR_NAME` Tool to update your custom "Mixmax Calendar" vanity URL name. Use when you need to change the calendar name that appears in your personalized calendar link (e.g., https://cal.mixmax.com/). This setting is available in the Calendar settings from the Mixmax dashboard. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Any string that you would like to use to represent your calendar in your vanity URL (e.g., https://cal.mixmax.com/) | #### 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 Contact **Slug:** `MIXMAX_UPDATE_CONTACT` Tool to update a specific contact by ID. Use when you need to modify contact details such as name, email, or custom metadata fields. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The MongoDB ObjectID of the contact to update | | `meta` | object | No | Contact variables from any source (ex. Salesforce) that are used for sequences and templates | | `name` | string | No | Name of the contact | | `email` | string | No | Email address for the contact | | `contactId` | string | No | Google ID that this contact is associated with | | `salesforceId` | string | No | Salesforce ID for a contact or lead that this contact is associated with | #### 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 Contact Group **Slug:** `MIXMAX_UPDATE_CONTACT_GROUP` Tool to update a contact group by ID. Use when you need to modify a contact group's name, sharing settings, or team associations. Note: This endpoint is deprecated but still functional. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The _id of the Contact Group to edit. | | `name` | string | No | Name for the Contact Group. Update this to change the group name. | | `expand` | string | No | Pass 'userId' to replace userId with _id and name in the response. | | `shared` | array | No | Sharing settings with userEmail and accepted properties for each user. | | `teamIds` | array | No | Array of team IDs to associate with the contact group. | #### 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 Contact Note **Slug:** `MIXMAX_UPDATE_CONTACT_NOTE` Tool to update a note on a contact by its ID. Only the creator of the note can edit it. The contact note will show "(edited)" in the UI after update. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `text` | string | Yes | The new text content for the note. The note will show "(edited)" in the UI after update. | | `expand` | string | No | Pass expand=userId to include the owner's name and email in the response. | | `note_id` | string | Yes | The _id of the note for the contact to update. | | `contact_id` | string | Yes | The _id of the contact the note belongs to. Only the creator of the note can edit it. | #### 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 insights report **Slug:** `MIXMAX_UPDATE_INSIGHTS_REPORT` Tool to update an existing insights report in Mixmax. Use when you need to modify a report's title, type, or query. All fields 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 insights report to update | | `type` | string ("messages" | "meetings" | "groups" | "users" | "sequences" | "templates" | "delegators" | "customers") | No | Enum for insights report types. | | `query` | string | No | The report query to run | | `title` | string | No | The title of the report (defaults to 'Untitled report' if not provided) | #### 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 by ID **Slug:** `MIXMAX_UPDATE_MESSAGE` Tool to update a message by its unique ID. Use when you need to modify message content, recipients, or tracking settings for an existing message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cc` | array | No | List of CC recipients to update. | | `id` | string | Yes | The unique message identifier to update. | | `to` | array | No | List of primary recipients to update. | | `bcc` | array | No | List of BCC recipients to update. | | `body` | string | No | HTML formatted message content to update. | | `subject` | string | No | Message subject line to update. | | `trackingEnabled` | boolean | No | Whether email open tracking should be enabled for this message. | | `userHasModified` | boolean | No | Whether the user has manually modified the message. | | `fileTrackingEnabled` | boolean | No | Whether file download tracking should be enabled for this message. | | `linkTrackingEnabled` | boolean | No | Whether link click tracking should be enabled for this message. | | `notificationsEnabled` | boolean | No | Whether desktop notifications should be enabled for this 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 | ### Update Sequence Folder by ID **Slug:** `MIXMAX_UPDATE_SEQUENCE_FOLDER` Tool to update a sequence folder by its unique ID in Mixmax. Use when you need to modify an existing sequence folder's name or other properties. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the sequence folder to update | | `name` | string | No | The name of the sequence folder 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 Snippet Tag **Slug:** `MIXMAX_UPDATE_SNIPPET_TAG` Tool to update a snippet tag (folder) by its unique ID. Use when you need to modify a snippet tag's name, sharing settings, or inline status. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the snippet tag to update | | `name` | string | No | The name of the snippet tag (folder). Update this to rename the tag. | | `shared` | object | No | Sharing configuration for the snippet tag. Pass sharing settings to control who can access the tag. | | `isInline` | boolean | No | Whether the snippet tag is inline. Set to true for inline tags, false otherwise. | #### 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 Team **Slug:** `MIXMAX_UPDATE_TEAM` Tool to update a team's information by ID. Use when you need to modify a team's name or other properties. Only admins can perform this operation. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `id` | string | Yes | The unique identifier of the team to update. Only admins can update team information. | | `name` | string | Yes | The new name for the team. | #### 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 Current User Preferences **Slug:** `MIXMAX_UPDATE_USER_PREFERENCES_ME` Tool to update preferences for the currently authenticated user. Use when you need to modify user-specific settings like tracking preferences, UI features, hotkeys, or calendar settings. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `undoDelay` | integer | No | Delay in seconds before sending email (allows undo within this time). | | `appHotkeyMac` | string | No | Keyboard hotkey for Mac to open the app (e.g., 'Command+Shift+M'). | | `appHotkeyWin` | string | No | Keyboard hotkey for Windows to open the app (e.g., 'Control+Shift+M'). | | `emojiEnabled` | boolean | No | Enable or disable emoji support in the compose window. | | `weekStartDay` | integer | No | Week start day for calendar view (0=Sunday, 1=Monday, 2=Tuesday, etc.). | | `defaultFontSize` | string | No | Default font size for compose window (e.g., 'small', 'medium', 'large'). | | `defaultLocation` | string | No | Default location string for scheduled meetings. | | `undoSendEnabled` | boolean | No | Enable or disable the undo send feature for emails. | | `defaultMeetingLength` | integer | No | Default meeting length in milliseconds (e.g., 1800000 for 30 minutes). | | `preventDoubleBookings` | boolean | No | Prevent double bookings when scheduling meetings on calendar. | | `defaultTrackingEnabled` | boolean | No | Enable or disable default tracking for emails. | | `slashCommandMenuEnabled` | boolean | No | Enable or disable the slash command menu in compose. | | `autoLinkConversionEnabled` | boolean | No | Enable or disable automatic link conversion when pasting URLs. | | `defaultFileTrackingEnabled` | boolean | No | Enable or disable default file tracking for email attachments. | | `defaultLinkTrackingEnabled` | boolean | No | Enable or disable default link tracking in emails. | | `defaultNotificationsEnabled` | boolean | No | Enable or disable default notifications. | | `templateShortcutMenuEnabled` | boolean | No | Enable or disable the template shortcut menu. | #### 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 |