Skip to main content
Mixmax logo
  • Category: email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 94
  • Triggers: 0
  • Slug: MIXMAX
  • Version: 20261101_00

Tools

Slug: MIXMAX_ADD_CONTACT_TO_GROUPTool 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

string
required
The _id of the Contact Group the Contact will be added to.
object
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.
string
Name of the contact to add.
string
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.
array
For bulk adding recipients. Max 100 entries. Each entry must have either email or contactId field.
string
The id of the contact to add to the group. Required if email not provided and contacts array is empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_ADD_EMAIL_TO_UNSUBSCRIBE_LISTTool to add an email address to the Mixmax unsubscribe list. Use when you need to prevent sending emails to a specific address.

Input Parameters

string
required
The email address to add to the unsubscribe list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_ADD_SNIPPET_TO_TAGTool 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

string
required
The snippet tag ID to add the snippet to
string
required
The ID of the snippet to add to the tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_ADD_TEAM_MEMBERSTool 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

string
required
The unique identifier of the team to add members to
array
required
Array of member objects to add to the team. Each object must contain an email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CANCEL_SEQUENCESTool 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

array
Email addresses of specific recipients to cancel from all sequences. When omitted, all active recipients across all sequences are canceled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_CODE_SNIPPETTool 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

string
required
The HTML of your code snippet. This is what appears in the editor.
string
The code editor theme for syntax highlighting.
string
The title of the code snippet.
string
The programming language your code is written in (for syntax highlighting).
string
Background color in RGB format. Must be of format rgb(0-255, 0-255, 0-255).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_CONTACTTool 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

object
Contact variables from any source (ex. Salesforce) that are used to populate sequences and templates variables
string
Contact’s name
string
required
Email address for the contact. This is unique per contact. If a contact with this email already exists, the contact will be merged.
boolean
Merges information from third-party sources like Salesforce
array
Array of contact group IDs this contact belongs to
string
Google Contacts ID for the same email address
boolean
Increments contact’s usedCount and sets timestamp to now
string
Salesforce ID if contact exists in Salesforce

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_CONTACT_GROUPTool 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

string
required
Name of the new contact group.
string
Pass ‘userId’ to replace the userId with _id and name in the response.
array
Array of contacts to add to the new group. Each contact should have an email and optionally a name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_CONTACT_NOTETool to create a note for a contact. Use when you need to add a new note to a contact by their ID.

Input Parameters

string
required
The _id of the contact to add a note to.
string
required
The content of the note to be created.
string
Pass expand=userId to expand the response to include the name and email of the note owner.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_INSIGHTS_REPORTTool 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

string ("messages" | "meetings" | "groups" | "users" | "sequences" | "templates" | "delegators" | "customers")
Enum for insights report types.
string
The report query to run using Mixmax query syntax. Defaults to ‘sent:last30days from:everyone’ if not provided.
string
The title of the report. Defaults to ‘Super report’ if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_INTEGRATION_ENHANCEMENTTool 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

string
required
URL to the icon image that will be displayed in the Enhance menu
string
required
The name of the enhancement that shows up in the Enhance menu
string
required
URL that opens in a new browser window when the enhancement is clicked in the Enhance menu. This is where users configure the enhancement.
string
required
Tooltip text that appears when hovering over the enhancement icon in the UI
string
required
RESTful API endpoint that is called with the enhancement instance parameters to return HTML representation of the enhancement content

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_INTEGRATIONS_COMMANDTool 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

string
required
String name of the command that shows up in the command menu
string
required
Typing this string after a slash will trigger the command. Must be globally unique. Spaces not allowed.
string
required
URL called when the user presses enter after typing a command
string
required
String parameter placeholder text that shows up in the command menu
string
required
URL that is called with the command text that returns an array of suggestions

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_INTEGRATIONS_SIDEBARSTool 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

string
required
The URL of the integration. The webpage at this URL should use the Sidebar SDK to communicate with Mixmax
string
required
The name of the sidebar integration to show up in developer settings
string
Icon name identifier (e.g., ‘star’). Required if iconImage is not provided, must be used with iconColor
string
Icon color in hex format (e.g., ‘#0000FF’). Required if iconImage is not provided, must be used with iconName
string
Icon image URL. Either iconImage, or both iconName and iconColor must be provided

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_LIVEFEED_SEARCHTool 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

string
required
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’)
string
The title of the search. If not specified, defaults to ‘Untitled Search’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_MESSAGETool to create a draft Mixmax message (email). Use when you need to compose a new email draft in Mixmax.

Input Parameters

array
Recipients of message in the ‘cc’ field. Array of objects with ‘email’ (required) and ‘name’ (optional) properties.
array
Recipients of message in the ‘to’ field. Array of objects with ‘email’ (required) and ‘name’ (optional) properties.
array
Recipients of message in the ‘bcc’ field. Array of objects with ‘email’ (required) and ‘name’ (optional) properties.
string
HTML body of the message.
string
Email subject line.
string
Gmail Message ID if replying to existing message.
boolean
Email tracking enabled (default: false).
boolean
Set to true to create a Gmail draft for the message (default: false).
boolean
File/download tracking enabled (default: false).
Link tracking enabled (default: false).
boolean
Desktop notifications enabled (default: false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_RULECreate a Mixmax rule with an event trigger and optional name and filter, for event-based automation such as message sent, opened, or clicked.

Input Parameters

string
The name of the rule to identify it
string
JSON string representing filter criteria for the rule. Use ’{}’ for no filter, or specify conditions to match events.
object
required
Rule trigger configuration with type and eventName fields. Defines when the rule should fire.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_RULE_ACTIONTool 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

string
required
The ID of the rule to add the action to
string
required
The webhook URL endpoint for webhook-type actions
string
required
The type of action to create (e.g., ‘webhook’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_SEQUENCE_FOLDERTool 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

string
required
The name of the sequence folder to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_SNIPPET_TAGTool 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

string
required
Display name of the snippet tag/folder to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_CREATE_TEAMTool 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

string
required
The name of the team to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_CONTACTTool to delete a contact by ID. Use when you need to remove a contact from Mixmax.

Input Parameters

string
required
The MongoDB ObjectID of the contact to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_CONTACT_GROUPTool 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

string
required
The _id of the Contact Group to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_CONTACT_NOTETool 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

string
required
The _id of the note for the contact to delete.
string
required
The _id of the contact the note belongs to. Only the creator of the note can delete it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_INTEGRATION_ENHANCEMENTTool to delete an integration enhancement by its ID. Use when you need to remove an enhancement from the Mixmax platform.

Input Parameters

string
required
The unique identifier of the enhancement to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_INTEGRATIONS_COMMANDS_IDTool to delete a slash command by its unique ID from Mixmax integrations. Use when you need to permanently remove a slash command.

Input Parameters

string
required
The unique identifier (_id) of the slash command to delete. This is the command’s ID returned when creating or listing commands.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_INTEGRATIONS_SIDEBARSTool to delete a sidebar integration by its ID. Use when removing an integration sidebar from Mixmax.

Input Parameters

string
required
The identifier of the sidebar integration to remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_RULEDelete a Mixmax rule by ID. A 404 response is reported as success, so success does not establish that the rule existed or was deleted by this request.

Input Parameters

string
required
The unique identifier of the rule to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_RULE_ACTIONTool to delete an action from a Mixmax rule. Use when you need to remove a specific action from an existing rule.

Input Parameters

string
required
The ID of the rule
string
required
The ID of the action to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_SEQUENCE_FOLDERTool 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

string
required
The unique identifier of the sequence folder to delete. WARNING: This permanently deletes the sequence folder. This action cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_SNIPPETTool 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

string
required
The unique identifier of the snippet to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_SNIPPET_TAGTool to delete a snippet tag by its unique ID. Use when you need to remove a snippet tag from Mixmax.

Input Parameters

string
required
The identifier of the snippet tag to remove

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_TEAMTool 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

string
required
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_DELETE_UNSUBSCRIBETool 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

string
required
The email address to remove from the unsubscribe list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_CODE_SNIPPETTool 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

string
required
The unique identifier of the code snippet to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_CONTACTTool to retrieve a single contact by ID from Mixmax. Use when you need to fetch detailed information about a specific contact.

Input Parameters

string
required
The _id of the contact object to retrieve
string
Fields to expand in comma separated form. Currently supporting ‘firstName’, ‘lastName’, and ‘groups’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_CONTACT_GROUPTool 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

string
required
The _id of the contactgroup object to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_CONTACTGROUP_CONTACTSTool 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

string
required
The _id of the contactgroup object to fetch membership for
string ("name" | "email" | "timestamp" | "usedCount")
Sort field options for contact listing
string ("today" | "yesterday" | "last7" | "thisWeek" | "lastWeek" | "last30" | "thisMonth" | "lastMonth" | "last12Months" | "thisYear" | "lastYear" | "allTime" | "specific")
Date range options for analytics
string
When dates is ‘specific’, the lower bound timestamp in milliseconds. Required if dates=‘specific’.
string
When dates is ‘specific’, the upper bound timestamp in milliseconds. Required if dates=‘specific’.
string
Fields to expand in comma separated form. Currently supporting ‘firstName’ and ‘lastName’ and ‘groups’.
boolean
True to sort ascending (A-Z), false for descending
boolean
Include analytics in the response. When enabled, each contact will include engagement metrics like sent, opened, clicked, replied, etc.
integer
The client’s timezone offset, in minutes. Used to correctly interpret date ranges for analytics.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_CONTACT_NOTESRetrieve notes associated with a Mixmax contact by contact ID, optionally requesting expanded details. DEPRECATED: This endpoint may be removed in a future API version.

Input Parameters

string
required
The _id of the contact to retrieve notes for.
string
Optional comma-separated list of fields to expand with additional details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_FILEREQUESTSRetrieve a page of file requests sent through Mixmax, including associated uploads when returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_INSIGHTS_REPORT_BY_IDRetrieve an insights report by ID from the first page of Mixmax reports, including its title, query, and metadata. A report absent from that page is reported as not found.

Input Parameters

string
required
The unique identifier (_id) of the insights report to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_INTEGRATIONS_COMMANDSRetrieve a page of slash command integrations accessible in Mixmax, with pagination information when returned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_INTEGRATIONS_ENHANCEMENTSTool to retrieve a list of enhancements that you have access to in Mixmax. Use when you need to view available integrations enhancements.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_INTEGRATIONS_SIDEBARSRetrieve sidebar integrations accessible in Mixmax. The tool returns the integrations from a single response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_LIVEFEEDTool 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

integer
Number of results to return per page. Maximum 10,000. Default: 50
string
The query to execute. Takes the same format as queries in the live feed UI (e.g., ‘from:user@example.com opened:>5’)
boolean
Include aggregate statistics with query results (opened count, clicked count, etc.). Default: true
integer
Paging offset for pagination. Use this to retrieve subsequent pages of results. Default: 0
string
RFC timezone descriptor for date/time formatting (e.g., ‘America/Los_Angeles’). Defaults to UTC if not specified
array
Restricts results to specified message IDs only. Useful for fetching specific messages

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_LIVEFEED_EVENTSTool 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

string
The identifier of the message to fetch events for. Either this or contactEmail must be provided.
string
The email address of the contact to fetch events for. Either this or messageId must be provided.
boolean
If contactEmail is provided, whether to also include events between the contactEmail and all of your Mixmax teammates. Default: false
boolean
required
Whether the message was sent via Mixmax (true) or some other email client (false)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_MEETING_INVITESTool 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

string
Cursor string to fetch the next page of results. Obtained from a previous response.
integer
Number of meeting invites to return per page. Maximum is typically 300.
string
Cursor string to fetch the previous page of results. Used for walking pages backwards.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_MESSAGETool to retrieve a single message by its unique ID. Use when you need to fetch detailed information about a specific message.

Input Parameters

string
required
The unique message identifier to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_MESSAGESRetrieve a page of Mixmax messages, including drafts, scheduled messages, and sent messages.

Input Parameters

string
Pagination cursor for retrieving the next page of results. Use the value from the previous response.
integer
Maximum number of messages to return per page

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_POLLSTool 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

string
Cursor token for pagination. Pass the ‘next’ value from the previous response to fetch the next page of results.
integer
Maximum number of poll results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_QARetrieve a page of Mixmax Question & Answer surveys, including questions, responses, and respondent details. The tool does not expose pagination cursors or accept a cursor to retrieve subsequent pages.

Input Parameters

integer
Number of results to return per page. Use this to control pagination.
string
Comma-delimited list of field names to return (using dot notation for nested properties). Example: ‘_id,title,questions.content’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_REPORTS_DATA_TABLEQuery Mixmax report analytics for messages, meetings, or sequences. Results can include metrics such as opens, clicks, replies, and percentages.

Input Parameters

string ("messages" | "meetings" | "sequences")
required
Data type to query. Valid values: messages (email analytics), meetings (meeting analytics), sequences (sequence analytics)
integer
Maximum number of results to return. Default: 1000, Max: 10000
string
Query filter string to narrow down results (e.g., ‘sent:last30days from:everyone’, ‘delivered:last7days’)
string
Comma-delimited list of fields to return in the response (e.g., ‘delivered,opened,clicked’)
integer
Pagination offset for retrieving results beyond the limit. Default: 0
string
Field to sort results by. Defaults to ‘sent’ for messages or ‘start’ for meetings
string
Aggregation method for grouping results. For messages: delegator, customerDomain, message, recipient, emailsByDomain, sender, senderGroup, time, template. For meetings: groupmember, teammate, group
boolean
Sort results in descending order. Default: true
string
RFC timezone string for time-based data (e.g., ‘America/Los_Angeles’, ‘Europe/London’). Default: UTC

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_RULESTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_RULES_IDTool 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

string
required
The unique identifier of the rule to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_SALESFORCE_ACCOUNTRetrieve Salesforce account information for the authenticated Mixmax user. A 403 returns a message indicating either no Salesforce connection or insufficient permission, so it does not distinguish between them.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_SEQUENCE_FOLDERTool 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

string
required
The unique identifier of the sequence folder to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_SNIPPETS_IDTool 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

string
required
The unique identifier of the snippet to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_SNIPPET_TAGTool 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

string
required
The unique identifier of the snippet tag to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_SNIPPET_TAGSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_TEAM_MEMBERSTool 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

string
required
The unique identifier of the team whose members to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_TEAMSRetrieve a page of Mixmax teams that the authenticated user is a member of.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_UNSUBSCRIBESTool to retrieve a list of unsubscribed email addresses from Mixmax. Use when you need to view contacts who have unsubscribed from sequences.

Input Parameters

string
A cursor used to fetch the next page in the collection, for pagination. Use the value from the previous response.
integer
The number of results to return per page. Defaults to 50 if not specified.
string
A comma-delimited list of field names to return only specific fields in the response.
string
The cursor to start fetching the previous page of results. Use the value from the previous response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_USER_PREFERENCES_METool to retrieve preferences for the currently authenticated user. Use when you need to fetch user-specific settings and configuration options.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_USERS_METool to retrieve information about the currently authenticated user. Use when you need to fetch the current user’s ID and profile details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_GET_YES_NOTool 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

string
Cursor token for pagination. Pass the ‘next’ value from the previous response to fetch the next page of results.
integer
Maximum number of Yes/No question results to return per page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_LIST_CODE_SNIPPETSList a page of Formatted Code enhancements available in your Mixmax account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_LIST_CONTACT_GROUPSTool 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

string ("name" | "_id")
Sort field options for contact groups.
string
Supports userId expansion. Specify ‘userId’ to expand user details.
Partial, case-insensitive search on the group name. Use this to filter groups by name.
boolean
Sort in ascending order (A-Z). Default is false (descending).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_LIST_CONTACTSList or search a page of Mixmax contacts with optional analytics using this deprecated tool. Contacts shared via contact groups are not returned unless a search is provided.

Input Parameters

string ("name" | "email" | "timestamp" | "usedCount")
Fields to sort contacts by
string ("today" | "last30" | "allTime")
Analytics date range options
integer
Number of results per page. Default: 50.
string
Lower bound for specific date range filter in ISO 8601 date-time format.
string
Upper bound for specific date range filter in ISO 8601 date-time format.
string
Comma-separated list of fields to expand in response: firstName, lastName, groups, notes, salesforce.
string
Optional search string to filter contacts. When provided, searches across all contact fields. Also enables includeShared parameter.
string
Cursor for fetching the next page.
boolean
Include contacts shared with you via shared contact groups. Requires search parameter to be provided.
boolean
Sort contacts in ascending order (A-Z). Defaults to false (descending order).
boolean
Include analytics data (sent, opened, clicked metrics) in the response.
integer
Client timezone offset in minutes for analytics date calculations.
string
Cursor for fetching the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_LIST_RULE_ACTIONSTool 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

string
required
The unique identifier of the rule whose actions to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_LIST_SEQUENCE_FOLDERSRetrieve a page of Mixmax sequence folders for viewing or organizing sequences. Supports pagination using cursors.

Input Parameters

integer
Number of results per page. Default: 50.
string
Cursor for fetching the next page.
string
Cursor for fetching the previous page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_LIST_SEQUENCESRetrieve a list of Mixmax sequences that you have access to, with an optional result limit. An expansion can be requested, but expanded stages or user details may not fit the response schema.

Input Parameters

integer
Maximum number of sequences to return
string
Fields to expand in comma-separated form. Supports ‘stages’ and ‘userId’ for expanded details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_LIST_SNIPPETSTool 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

integer
Maximum number of results to return
boolean
Return only deleted templates (in trash). Deleted snippets remain accessible for 28 days before automatic purging.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_PATCH_RULES_IDTool 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

string
required
The unique identifier of the rule to update
string
The name of the rule to update
string
JSON string filter for the rule. Must be a valid JSON string.
object
Trigger configuration for a rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_PATCH_RULES_ID_ACTIONS_IDTool to update an action within a Mixmax rule. Use when you need to modify action properties like webhook URL or action type.

Input Parameters

string
required
The ID of the rule containing the action
string
The webhook URL for webhook-type actions. Update this to change the webhook endpoint.
string
The type of action (e.g., ‘webhook’). Only required when changing action type.
string
required
The ID of the action to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_PATCH_SNIPPETS_IDTool 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

string
required
The unique identifier of the snippet to update
string
Name/label of the snippet to update
string
Subject line/title for the snippet. Used as the subject line when the snippet is inserted into an email.
string
HTML content of the snippet. Contains the body text that will be inserted when using the snippet.
boolean
Whether the snippet is inline (inserted at cursor position) or standalone (replaces entire email body)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_QUERY_CONTACTSTool 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

string
required
The search query string to find matching contacts
boolean
Whether to include matching Salesforce Accounts in the query results. If not specified, defaults to API’s default behavior
boolean
Whether to include Salesforce Contacts and Leads in the query results. If not specified, defaults to API’s default behavior
boolean
Whether to include matching Salesforce Opportunities in the query results. If not specified, defaults to API’s default behavior

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_REMOVE_CONTACT_FROM_GROUPTool 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

string
required
The unique identifier of the contact group
string
required
The unique identifier of the contact to remove from the group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_REMOVE_TEAM_MEMBERTool 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

string
required
The unique identifier of the team
string
required
The unique identifier of the member to remove from the team

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_SEARCH_SEQUENCESTool 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

string
Email address of the sequence recipient to search for. Use this to filter sequences by recipient email.
integer
Maximum number of results to return per page. Use together with offset to page through results.
integer
Number of results to skip for pagination. Use together with limit to page through results when total exceeds a single page.
string
ID of the sequence to search within. Use this to filter recipients by a specific sequence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_SEND_MESSAGETool 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

string
required
The unique message identifier of the draft to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_SEND_SNIPPETTool 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

string
required
The unique identifier of the snippet to send.
array
required
List of recipients to send the snippet to. Each recipient must have an email address and optionally a name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_SEND_TEST_MESSAGETool 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

string
HTML-formatted message content.
string
The message subject line.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_CONTACTTool 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

string
required
The MongoDB ObjectID of the contact to update
object
Contact variables from any source (ex. Salesforce) that are used for sequences and templates
string
Name of the contact
string
Email address for the contact
string
Google ID that this contact is associated with
string
Salesforce ID for a contact or lead that this contact is associated with

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_CONTACT_GROUPTool 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

string
required
The _id of the Contact Group to edit.
string
Name for the Contact Group. Update this to change the group name.
string
Pass ‘userId’ to replace userId with _id and name in the response.
array
Sharing settings with userEmail and accepted properties for each user.
array
Array of team IDs to associate with the contact group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_CONTACT_NOTETool 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

string
required
The new text content for the note. The note will show “(edited)” in the UI after update.
string
Pass expand=userId to include the owner’s name and email in the response.
string
required
The _id of the note for the contact to update.
string
required
The _id of the contact the note belongs to. Only the creator of the note can edit it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_INSIGHTS_REPORTUpdate an existing Mixmax insights report by ID, optionally changing its title, type, or query.

Input Parameters

string
required
The unique identifier (_id) of the insights report to update
string ("messages" | "meetings" | "groups" | "users" | "sequences" | "templates" | "delegators" | "customers")
Enum for insights report types.
string
The report query to run
string
The title of the report (defaults to ‘Untitled report’ if not provided)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_MESSAGETool 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

array
List of CC recipients to update.
string
required
The unique message identifier to update.
array
List of primary recipients to update.
array
List of BCC recipients to update.
string
HTML formatted message content to update.
string
Message subject line to update.
boolean
Whether email open tracking should be enabled for this message.
boolean
Whether the user has manually modified the message.
boolean
Whether file download tracking should be enabled for this message.
Whether link click tracking should be enabled for this message.
boolean
Whether desktop notifications should be enabled for this message.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_SEQUENCE_FOLDERUpdate the name of a Mixmax sequence folder by its unique ID.

Input Parameters

string
required
The unique identifier of the sequence folder to update
string
The name of the sequence folder to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_SNIPPET_TAGTool 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

string
required
The unique identifier of the snippet tag to update
string
The name of the snippet tag (folder). Update this to rename the tag.
object
Sharing configuration for the snippet tag. Pass sharing settings to control who can access the tag.
boolean
Whether the snippet tag is inline. Set to true for inline tags, false otherwise.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_TEAMUpdate a Mixmax team’s name by its ID. Only admins can perform this operation.

Input Parameters

string
required
The unique identifier of the team to update. Only admins can update team information.
string
required
The new name for the team.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MIXMAX_UPDATE_USER_PREFERENCES_METool 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

integer
Delay in seconds before sending email (allows undo within this time).
string
Keyboard hotkey for Mac to open the app (e.g., ‘Command+Shift+M’).
string
Keyboard hotkey for Windows to open the app (e.g., ‘Control+Shift+M’).
boolean
Enable or disable emoji support in the compose window.
integer
Week start day for calendar view (0=Sunday, 1=Monday, 2=Tuesday, etc.).
string
Default font size for compose window (e.g., ‘small’, ‘medium’, ‘large’).
string
Default location string for scheduled meetings.
boolean
Enable or disable the undo send feature for emails.
integer
Default meeting length in milliseconds (e.g., 1800000 for 30 minutes).
boolean
Prevent double bookings when scheduling meetings on calendar.
boolean
Enable or disable default tracking for emails.
boolean
Enable or disable the slash command menu in compose.
Enable or disable automatic link conversion when pasting URLs.
boolean
Enable or disable default file tracking for email attachments.
Enable or disable default link tracking in emails.
boolean
Enable or disable default notifications.
boolean
Enable or disable the template shortcut menu.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not