NAiOS IconNAiOS Logo
Volver al catálogo

Mixmax

mixmax

The #1 Sales Engagement Platform for Gmail. Mixmax provides email tracking, scheduling, sequences, and productivity tools for sales teams.

Acciones
96
Triggers
0
Autenticación
OAuth gestionado
No
Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (96)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Add Contact to GroupMIXMAX_ADD_CONTACT_TO_GROUPAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The _id of the Contact Group the Contact will be added to.

  • metaobject

    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.

  • namestring

    Name of the contact to add.

  • emailstring

    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.

  • contactsobject[]

    For bulk adding recipients. Max 100 entries. Each entry must have either email or contactId field.

  • contactIdstring

    The id of the contact to add to the group. Required if email not provided and contacts array is empty.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add Email to Unsubscribe ListMIXMAX_ADD_EMAIL_TO_UNSUBSCRIBE_LISTAcción

Tool to add an email address to the Mixmax unsubscribe list. Use when you need to prevent sending emails to a specific address.

Parámetros de entrada

  • emailstringObligatorio

    The email address to add to the unsubscribe list

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add Snippet to TagMIXMAX_ADD_SNIPPET_TO_TAGAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The snippet tag ID to add the snippet to

  • snippetIdstringObligatorio

    The ID of the snippet to add to the tag

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Add Team MembersMIXMAX_ADD_TEAM_MEMBERSAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the team to add members to

  • membersobject[]Obligatorio

    Array of member objects to add to the team. Each object must contain an email address.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Cancel Sequence RecipientsMIXMAX_CANCEL_SEQUENCESAcción

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.

Parámetros de entrada

  • emailsstring[]

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Code SnippetMIXMAX_CREATE_CODE_SNIPPETAcción

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.

Parámetros de entrada

  • htmlstringObligatorio

    The HTML of your code snippet. This is what appears in the editor.

  • themestring

    The code editor theme for syntax highlighting.

  • titlestring

    The title of the code snippet.

  • languagestring

    The programming language your code is written in (for syntax highlighting).

  • backgroundstring

    Background color in RGB format. Must be of format rgb(0-255, 0-255, 0-255).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create ContactMIXMAX_CREATE_CONTACTAcción

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.

Parámetros de entrada

  • metaobject

    Contact variables from any source (ex. Salesforce) that are used to populate sequences and templates variables

  • namestring

    Contact's name

  • emailstringObligatorio

    Email address for the contact. This is unique per contact. If a contact with this email already exists, the contact will be merged.

  • enrichboolean

    Merges information from third-party sources like Salesforce

  • groupsstring[]

    Array of contact group IDs this contact belongs to

  • contactIdstring

    Google Contacts ID for the same email address

  • markAsUsedboolean

    Increments contact's usedCount and sets timestamp to now

  • salesforceIdstring

    Salesforce ID if contact exists in Salesforce

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Contact GroupMIXMAX_CREATE_CONTACT_GROUPAcción

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.

Parámetros de entrada

  • namestringObligatorio

    Name of the new contact group.

  • expandstring

    Pass 'userId' to replace the userId with _id and name in the response.

  • contactsobject[]

    Array of contacts to add to the new group. Each contact should have an email and optionally a name.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Contact NoteMIXMAX_CREATE_CONTACT_NOTEAcción

Tool to create a note for a contact. Use when you need to add a new note to a contact by their ID.

Parámetros de entrada

  • idstringObligatorio

    The _id of the contact to add a note to.

  • textstringObligatorio

    The content of the note to be created.

  • expandstring

    Pass expand=userId to expand the response to include the name and email of the note owner.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create insights reportMIXMAX_CREATE_INSIGHTS_REPORTAcción

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.

Parámetros de entrada

  • typestringenum

    Enum for insights report types.

    messagesmeetingsgroupsuserssequencestemplatesdelegatorscustomers
  • querystring

    The report query to run using Mixmax query syntax. Defaults to 'sent:last30days from:everyone' if not provided.

  • titlestring

    The title of the report. Defaults to 'Super report' if not provided.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Integration EnhancementMIXMAX_CREATE_INTEGRATION_ENHANCEMENTAcción

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.

Parámetros de entrada

  • iconstringObligatorio

    URL to the icon image that will be displayed in the Enhance menu

  • namestringObligatorio

    The name of the enhancement that shows up in the Enhance menu

  • editorUrlstringObligatorio

    URL that opens in a new browser window when the enhancement is clicked in the Enhance menu. This is where users configure the enhancement.

  • iconTooltipstringObligatorio

    Tooltip text that appears when hovering over the enhancement icon in the UI

  • resolverUrlstringObligatorio

    RESTful API endpoint that is called with the enhancement instance parameters to return HTML representation of the enhancement content

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Integrations CommandMIXMAX_CREATE_INTEGRATIONS_COMMANDAcción

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.

Parámetros de entrada

  • namestringObligatorio

    String name of the command that shows up in the command menu

  • commandstringObligatorio

    Typing this string after a slash will trigger the command. Must be globally unique. Spaces not allowed.

  • commandResolverUrlstringObligatorio

    URL called when the user presses enter after typing a command

  • parameterPlaceholderstringObligatorio

    String parameter placeholder text that shows up in the command menu

  • commandParameterHintsUrlstringObligatorio

    URL that is called with the command text that returns an array of suggestions

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Integrations SidebarsMIXMAX_CREATE_INTEGRATIONS_SIDEBARSAcción

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.

Parámetros de entrada

  • urlstringObligatorio

    The URL of the integration. The webpage at this URL should use the Sidebar SDK to communicate with Mixmax

  • namestringObligatorio

    The name of the sidebar integration to show up in developer settings

  • iconNamestring

    Icon name identifier (e.g., 'star'). Required if iconImage is not provided, must be used with iconColor

  • iconColorstring

    Icon color in hex format (e.g., '#0000FF'). Required if iconImage is not provided, must be used with iconName

  • iconImagestring

    Icon image URL. Either iconImage, or both iconName and iconColor must be provided

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Link ResolverMIXMAX_CREATE_LINK_RESOLVERAcción

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.

Parámetros de entrada

  • namestringObligatorio

    Arbitrary name for the link resolver to identify it in your integrations.

  • regexstringObligatorio

    Regular expression to match the URL pattern. Must not permit spaces. This regex is passed to JavaScript RegExp() constructor, so use JavaScript regex syntax.

  • descriptionstringObligatorio

    Description of what the link resolver does and what URL patterns it handles.

  • resolverUrlstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Livefeed SearchMIXMAX_CREATE_LIVEFEED_SEARCHAcción

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.

Parámetros de entrada

  • querystringObligatorio

    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')

  • titlestring

    The title of the search. If not specified, defaults to 'Untitled Search'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create MessageMIXMAX_CREATE_MESSAGEAcción

Tool to create a draft Mixmax message (email). Use when you need to compose a new email draft in Mixmax.

Parámetros de entrada

  • ccobject[]

    Recipients of message in the 'cc' field. Array of objects with 'email' (required) and 'name' (optional) properties.

  • toobject[]

    Recipients of message in the 'to' field. Array of objects with 'email' (required) and 'name' (optional) properties.

  • bccobject[]

    Recipients of message in the 'bcc' field. Array of objects with 'email' (required) and 'name' (optional) properties.

  • bodystring

    HTML body of the message.

  • subjectstring

    Email subject line.

  • inReplyTostring

    Gmail Message ID if replying to existing message.

  • trackingEnabledboolean

    Email tracking enabled (default: false).

  • userHasModifiedboolean

    Set to true to create a Gmail draft for the message (default: false).

  • fileTrackingEnabledboolean

    File/download tracking enabled (default: false).

  • linkTrackingEnabledboolean

    Link tracking enabled (default: false).

  • notificationsEnabledboolean

    Desktop notifications enabled (default: false).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create RuleMIXMAX_CREATE_RULEAcción

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.

Parámetros de entrada

  • namestring

    The name of the rule to identify it

  • filterstring

    JSON string representing filter criteria for the rule. Use '{}' for no filter, or specify conditions to match events.

  • triggerobjectObligatorio

    Rule trigger configuration with type and eventName fields. Defines when the rule should fire.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Rule ActionMIXMAX_CREATE_RULE_ACTIONAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The ID of the rule to add the action to

  • urlstringObligatorio

    The webhook URL endpoint for webhook-type actions

  • typestringObligatorio

    The type of action to create (e.g., 'webhook')

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Sequence FolderMIXMAX_CREATE_SEQUENCE_FOLDERAcción

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.

Parámetros de entrada

  • namestringObligatorio

    The name of the sequence folder to create

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create Snippet TagMIXMAX_CREATE_SNIPPET_TAGAcción

Tool to create a new snippet tag (folder) in Mixmax. Use when you need to organize snippets by creating a new tag or folder.

Parámetros de entrada

  • namestringObligatorio

    Display name of the snippet tag/folder to create

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Create TeamMIXMAX_CREATE_TEAMAcción

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.

Parámetros de entrada

  • namestringObligatorio

    The name of the team to create

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete ContactMIXMAX_DELETE_CONTACTAcción

Tool to delete a contact by ID. Use when you need to remove a contact from Mixmax.

Parámetros de entrada

  • idstringObligatorio

    The MongoDB ObjectID of the contact to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Contact GroupMIXMAX_DELETE_CONTACT_GROUPAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The _id of the Contact Group to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Contact NoteMIXMAX_DELETE_CONTACT_NOTEAcción

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.

Parámetros de entrada

  • note_idstringObligatorio

    The _id of the note for the contact to delete.

  • contact_idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Integration EnhancementMIXMAX_DELETE_INTEGRATION_ENHANCEMENTAcción

Tool to delete an integration enhancement by its ID. Use when you need to remove an enhancement from the Mixmax platform.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the enhancement to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete slash commandMIXMAX_DELETE_INTEGRATIONS_COMMANDS_IDAcción

Tool to delete a slash command by its unique ID from Mixmax integrations. Use when you need to permanently remove a slash command.

Parámetros de entrada

  • idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Integrations SidebarsMIXMAX_DELETE_INTEGRATIONS_SIDEBARSAcción

Tool to delete a sidebar integration by its ID. Use when removing an integration sidebar from Mixmax.

Parámetros de entrada

  • idstringObligatorio

    The identifier of the sidebar integration to remove

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Link ResolverMIXMAX_DELETE_LINK_RESOLVERAcción

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).

Parámetros de entrada

  • idstringObligatorio

    The unique identifier (_id field) of the link resolver to delete. WARNING: This permanently deletes the link resolver. This action cannot be undone.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete RuleMIXMAX_DELETE_RULEAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the rule to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Rule ActionMIXMAX_DELETE_RULE_ACTIONAcción

Tool to delete an action from a Mixmax rule. Use when you need to remove a specific action from an existing rule.

Parámetros de entrada

  • idstringObligatorio

    The ID of the rule

  • actionIdstringObligatorio

    The ID of the action to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Sequence FolderMIXMAX_DELETE_SEQUENCE_FOLDERAcción

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.

Parámetros de entrada

  • idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete SnippetMIXMAX_DELETE_SNIPPETAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the snippet to delete

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete Snippet TagMIXMAX_DELETE_SNIPPET_TAGAcción

Tool to delete a snippet tag by its unique ID. Use when you need to remove a snippet tag from Mixmax.

Parámetros de entrada

  • idstringObligatorio

    The identifier of the snippet tag to remove

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete TeamMIXMAX_DELETE_TEAMAcción

Tool to delete a team by its ID. Disbands the team permanently. Use only when confirmed by an admin, as this action is irreversible.

Parámetros de entrada

  • idstringObligatorio

    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.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Delete UnsubscribeMIXMAX_DELETE_UNSUBSCRIBEAcción

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.

Parámetros de entrada

  • emailstringObligatorio

    The email address to remove from the unsubscribe list

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Code SnippetMIXMAX_GET_CODE_SNIPPETAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the code snippet to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get contact by IDMIXMAX_GET_CONTACTAcción

Tool to retrieve a single contact by ID from Mixmax. Use when you need to fetch detailed information about a specific contact.

Parámetros de entrada

  • idstringObligatorio

    The _id of the contact object to retrieve

  • expandstring

    Fields to expand in comma separated form. Currently supporting 'firstName', 'lastName', and 'groups'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Contact GroupMIXMAX_GET_CONTACT_GROUPAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The _id of the contactgroup object to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Contactgroup ContactsMIXMAX_GET_CONTACTGROUP_CONTACTSAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The _id of the contactgroup object to fetch membership for

  • sortstringenum

    Sort field options for contact listing

    nameemailtimestampusedCount
  • datesstringenum

    Date range options for analytics

    todayyesterdaylast7thisWeeklastWeeklast30thisMonthlastMonthlast12MonthsthisYearlastYearallTime+1
  • sincestring

    When dates is 'specific', the lower bound timestamp in milliseconds. Required if dates='specific'.

  • untilstring

    When dates is 'specific', the upper bound timestamp in milliseconds. Required if dates='specific'.

  • expandstring

    Fields to expand in comma separated form. Currently supporting 'firstName' and 'lastName' and 'groups'.

  • sortAscendingboolean

    True to sort ascending (A-Z), false for descending

  • withAnalyticsboolean

    Include analytics in the response. When enabled, each contact will include engagement metrics like sent, opened, clicked, replied, etc.

  • timezoneOffsetinteger

    The client's timezone offset, in minutes. Used to correctly interpret date ranges for analytics.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Contact NotesMIXMAX_GET_CONTACT_NOTESAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The _id of the contact to retrieve notes for.

  • expandstring

    Optional comma-separated list of fields to expand with additional details.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get File RequestsMIXMAX_GET_FILEREQUESTSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get insights report by IDMIXMAX_GET_INSIGHTS_REPORT_BY_IDAcción

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.

Parámetros de entrada

  • idstringObligatorio

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

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Integrations CommandsMIXMAX_GET_INTEGRATIONS_COMMANDSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Integrations EnhancementsMIXMAX_GET_INTEGRATIONS_ENHANCEMENTSAcción

Tool to retrieve a list of enhancements that you have access to in Mixmax. Use when you need to view available integrations enhancements.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Link Resolver IntegrationsMIXMAX_GET_INTEGRATIONS_LINKRESOLVERSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Integrations SidebarsMIXMAX_GET_INTEGRATIONS_SIDEBARSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get live feed activity dataMIXMAX_GET_LIVEFEEDAcción

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.

Parámetros de entrada

  • limitinteger

    Number of results to return per page. Maximum 10,000. Default: 50

  • querystring

    The query to execute. Takes the same format as queries in the live feed UI (e.g., 'from:user@example.com opened:>5')

  • statsboolean

    Include aggregate statistics with query results (opened count, clicked count, etc.). Default: true

  • offsetinteger

    Paging offset for pagination. Use this to retrieve subsequent pages of results. Default: 0

  • timezonestring

    RFC timezone descriptor for date/time formatting (e.g., 'America/Los_Angeles'). Defaults to UTC if not specified

  • messageIdsstring[]

    Restricts results to specified message IDs only. Useful for fetching specific messages

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Livefeed EventsMIXMAX_GET_LIVEFEED_EVENTSAcción

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.

Parámetros de entrada

  • messageIdstring

    The identifier of the message to fetch events for. Either this or contactEmail must be provided.

  • contactEmailstring

    The email address of the contact to fetch events for. Either this or messageId must be provided.

  • includeTeammatesboolean

    If contactEmail is provided, whether to also include events between the contactEmail and all of your Mixmax teammates. Default: false

  • wasSentViaMixmaxbooleanObligatorio

    Whether the message was sent via Mixmax (true) or some other email client (false)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Meeting InvitesMIXMAX_GET_MEETING_INVITESAcción

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.

Parámetros de entrada

  • nextstring

    Cursor string to fetch the next page of results. Obtained from a previous response.

  • limitinteger

    Number of meeting invites to return per page. Maximum is typically 300.

  • previousstring

    Cursor string to fetch the previous page of results. Used for walking pages backwards.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Message by IDMIXMAX_GET_MESSAGEAcción

Tool to retrieve a single message by its unique ID. Use when you need to fetch detailed information about a specific message.

Parámetros de entrada

  • idstringObligatorio

    The unique message identifier to retrieve.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get MessagesMIXMAX_GET_MESSAGESAcción

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.

Parámetros de entrada

  • nextstring

    Pagination cursor for retrieving the next page of results. Use the value from the previous response.

  • limitinteger

    Maximum number of messages to return per page

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get PollsMIXMAX_GET_POLLSAcción

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.

Parámetros de entrada

  • nextstring

    Cursor token for pagination. Pass the 'next' value from the previous response to fetch the next page of results.

  • limitinteger

    Maximum number of poll results to return per page.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Q&A SurveysMIXMAX_GET_QAAcción

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.

Parámetros de entrada

  • limitinteger

    Number of results to return per page. Use this to control pagination.

  • fieldsstring

    Comma-delimited list of field names to return (using dot notation for nested properties). Example: '_id,title,questions.content'

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Reports Data TableMIXMAX_GET_REPORTS_DATA_TABLEAcción

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.

Parámetros de entrada

  • typestringObligatorioenum

    Data type to query. Valid values: messages (email analytics), meetings (meeting analytics), sequences (sequence analytics)

    messagesmeetingssequences
  • limitinteger

    Maximum number of results to return. Default: 1000, Max: 10000

  • querystring

    Query filter string to narrow down results (e.g., 'sent:last30days from:everyone', 'delivered:last7days')

  • fieldsstring

    Comma-delimited list of fields to return in the response (e.g., 'delivered,opened,clicked')

  • offsetinteger

    Pagination offset for retrieving results beyond the limit. Default: 0

  • sortBystring

    Field to sort results by. Defaults to 'sent' for messages or 'start' for meetings

  • groupBystring

    Aggregation method for grouping results. For messages: delegator, customerDomain, message, recipient, emailsByDomain, sender, senderGroup, time, template. For meetings: groupmember, teammate, group

  • sortDescboolean

    Sort results in descending order. Default: true

  • timezonestring

    RFC timezone string for time-based data (e.g., 'America/Los_Angeles', 'Europe/London'). Default: UTC

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get all rulesMIXMAX_GET_RULESAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Rule by IDMIXMAX_GET_RULES_IDAcción

Tool to fetch a single rule by its unique ID from Mixmax. Use when you need to retrieve detailed information about a specific rule.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the rule to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Salesforce account informationMIXMAX_GET_SALESFORCE_ACCOUNTAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Sequence Folder by IDMIXMAX_GET_SEQUENCE_FOLDERAcción

Tool to retrieve a single sequence folder by its ID from Mixmax. Use when you need to fetch details about a specific sequence folder.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the sequence folder to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Snippet by IDMIXMAX_GET_SNIPPETS_IDAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the snippet to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Snippet TagMIXMAX_GET_SNIPPET_TAGAcción

Tool to retrieve a single snippet tag (folder) by its unique ID. Use when you need to fetch details about a specific snippet tag.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the snippet tag to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Snippet TagsMIXMAX_GET_SNIPPET_TAGSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Team MembersMIXMAX_GET_TEAM_MEMBERSAcción

Tool to retrieve all members of a Mixmax team. Use when you need to list team memberships, including member details, roles, and invitation status.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the team whose members to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get TeamsMIXMAX_GET_TEAMSAcción

Tool to retrieve all teams that the authenticated user is a member of. Use when you need to list or view teams in Mixmax.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get UnsubscribesMIXMAX_GET_UNSUBSCRIBESAcción

Tool to retrieve a list of unsubscribed email addresses from Mixmax. Use when you need to view contacts who have unsubscribed from sequences.

Parámetros de entrada

  • nextstring

    A cursor used to fetch the next page in the collection, for pagination. Use the value from the previous response.

  • limitinteger

    The number of results to return per page. Defaults to 50 if not specified.

  • fieldsstring

    A comma-delimited list of field names to return only specific fields in the response.

  • previousstring

    The cursor to start fetching the previous page of results. Use the value from the previous response.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Current User PreferencesMIXMAX_GET_USER_PREFERENCES_MEAcción

Tool to retrieve preferences for the currently authenticated user. Use when you need to fetch user-specific settings and configuration options.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Current UserMIXMAX_GET_USERS_MEAcción

Tool to retrieve information about the currently authenticated user. Use when you need to fetch the current user's ID and profile details.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Get Yes/No QuestionsMIXMAX_GET_YES_NOAcción

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.

Parámetros de entrada

  • nextstring

    Cursor token for pagination. Pass the 'next' value from the previous response to fetch the next page of results.

  • limitinteger

    Maximum number of Yes/No question results to return per page.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Code SnippetsMIXMAX_LIST_CODE_SNIPPETSAcción

Tool to list all Formatted Code enhancements you've created. Use when you need to retrieve code snippets available in your Mixmax account.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Contact GroupsMIXMAX_LIST_CONTACT_GROUPSAcción

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.

Parámetros de entrada

  • sortstringenum

    Sort field options for contact groups.

    name_id
  • expandstring

    Supports userId expansion. Specify 'userId' to expand user details.

  • searchstring

    Partial, case-insensitive search on the group name. Use this to filter groups by name.

  • sortAscendingboolean

    Sort in ascending order (A-Z). Default is false (descending).

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List ContactsMIXMAX_LIST_CONTACTSAcción

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.

Parámetros de entrada

  • sortstringenum

    Fields to sort contacts by

    nameemailtimestampusedCount
  • datesstringenum

    Analytics date range options

    todaylast30allTime
  • sincestring

    Lower bound for specific date range filter in ISO 8601 date-time format.

  • untilstring

    Upper bound for specific date range filter in ISO 8601 date-time format.

  • expandstring

    Comma-separated list of fields to expand in response: firstName, lastName, groups, notes, salesforce.

  • searchstring

    Optional search string to filter contacts. When provided, searches across all contact fields. Also enables includeShared parameter.

  • includeSharedboolean

    Include contacts shared with you via shared contact groups. Requires search parameter to be provided.

  • sortAscendingboolean

    Sort contacts in ascending order (A-Z). Defaults to false (descending order).

  • withAnalyticsboolean

    Include analytics data (sent, opened, clicked metrics) in the response.

  • timezoneOffsetinteger

    Client timezone offset in minutes for analytics date calculations.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List insights reportsMIXMAX_LIST_INSIGHTS_REPORTSAcción

Tool to retrieve all insights reports from Mixmax. Use when you need to list all available reports with their metadata, including title, query, userId, and timestamps.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Rule ActionsMIXMAX_LIST_RULE_ACTIONSAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the rule whose actions to retrieve

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List Sequence FoldersMIXMAX_LIST_SEQUENCE_FOLDERSAcción

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.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List SequencesMIXMAX_LIST_SEQUENCESAcción

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.

Parámetros de entrada

  • limitinteger

    Maximum number of sequences to return

  • expandstring

    Fields to expand in comma-separated form. Supports 'stages' and 'userId' for expanded details.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

List SnippetsMIXMAX_LIST_SNIPPETSAcción

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.

Parámetros de entrada

  • limitinteger

    Maximum number of results to return

  • deletedOnlyboolean

    Return only deleted templates (in trash). Deleted snippets remain accessible for 28 days before automatic purging.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Rule by IDMIXMAX_PATCH_RULES_IDAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the rule to update

  • namestring

    The name of the rule to update

  • filterstring

    JSON string filter for the rule. Must be a valid JSON string.

  • triggerobject

    Trigger configuration for a rule.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Rule ActionMIXMAX_PATCH_RULES_ID_ACTIONS_IDAcción

Tool to update an action within a Mixmax rule. Use when you need to modify action properties like webhook URL or action type.

Parámetros de entrada

  • idstringObligatorio

    The ID of the rule containing the action

  • urlstring

    The webhook URL for webhook-type actions. Update this to change the webhook endpoint.

  • typestring

    The type of action (e.g., 'webhook'). Only required when changing action type.

  • actionIdstringObligatorio

    The ID of the action to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Snippet by IDMIXMAX_PATCH_SNIPPETS_IDAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the snippet to update

  • namestring

    Name/label of the snippet to update

  • titlestring

    Subject line/title for the snippet. Used as the subject line when the snippet is inserted into an email.

  • sourcestring

    HTML content of the snippet. Contains the body text that will be inserted when using the snippet.

  • isInlineboolean

    Whether the snippet is inline (inserted at cursor position) or standalone (replaces entire email body)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Post Reports Data TableMIXMAX_POST_REPORTS_DATA_TABLEAcción

Tool to generate a table report with specified analytics data for messages, meetings, or sequences. Use when you need to create custom reports with specific filtering, grouping, and sorting options.

Parámetros de entrada

  • typestringObligatorioenum

    Data type to query. Valid values: messages (email analytics), meetings (meeting analytics), sequences (sequence analytics)

    messagesmeetingssequences
  • limitinteger

    Maximum number of results to return. Default: 1000, Max: 10000

  • querystring

    Query filter string to narrow down results (e.g., 'sent:last30days from:everyone', 'delivered:last7days')

  • fieldsstring

    Comma-delimited list of fields to return in the response (e.g., 'delivered,opened,clicked')

  • offsetinteger

    Pagination offset for retrieving results beyond the limit. Default: 0

  • sortBystring

    Field to sort results by. Defaults to 'sent' for messages or 'start' for meetings

  • groupBystring

    Aggregation method for grouping results. For messages: delegator, customerDomain, message, recipient, emailsByDomain, sender, senderGroup, time, template. For meetings: groupmember, teammate, group

  • sortDescboolean

    Sort results in descending order. Default: true

  • timezonestring

    RFC timezone string for time-based data (e.g., 'America/Los_Angeles', 'Europe/London'). Default: UTC

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Query ContactsMIXMAX_QUERY_CONTACTSAcción

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.

Parámetros de entrada

  • qstringObligatorio

    The search query string to find matching contacts

  • includeSalesforceAccountsboolean

    Whether to include matching Salesforce Accounts in the query results. If not specified, defaults to API's default behavior

  • includeSalesforceContactsboolean

    Whether to include Salesforce Contacts and Leads in the query results. If not specified, defaults to API's default behavior

  • includeSalesforceOpportunitiesboolean

    Whether to include matching Salesforce Opportunities in the query results. If not specified, defaults to API's default behavior

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove Contact from GroupMIXMAX_REMOVE_CONTACT_FROM_GROUPAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the contact group

  • contactIdstringObligatorio

    The unique identifier of the contact to remove from the group

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Remove Team MemberMIXMAX_REMOVE_TEAM_MEMBERAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the team

  • member_idstringObligatorio

    The unique identifier of the member to remove from the team

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Search SequencesMIXMAX_SEARCH_SEQUENCESAcción

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.

Parámetros de entrada

  • emailstring

    Email address of the sequence recipient to search for. Use this to filter sequences by recipient email.

  • sequenceIdstring

    ID of the sequence to search within. Use this to filter recipients by a specific sequence.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send Message DraftMIXMAX_SEND_MESSAGEAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique message identifier of the draft to send.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send Snippet as EmailMIXMAX_SEND_SNIPPETAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the snippet to send.

  • toobject[]Obligatorio

    List of recipients to send the snippet to. Each recipient must have an email address and optionally a name.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Send Test MessageMIXMAX_SEND_TEST_MESSAGEAcción

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.

Parámetros de entrada

  • bodystring

    HTML-formatted message content.

  • subjectstring

    The message subject line.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Appointment Link Calendar NameMIXMAX_UPDATE_APPOINTMENT_LINK_CALENDAR_NAMEAcción

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/<your-name>). This setting is available in the Calendar settings from the Mixmax dashboard.

Parámetros de entrada

  • namestringObligatorio

    Any string that you would like to use to represent your calendar in your vanity URL (e.g., https://cal.mixmax.com/<name>)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update ContactMIXMAX_UPDATE_CONTACTAcción

Tool to update a specific contact by ID. Use when you need to modify contact details such as name, email, or custom metadata fields.

Parámetros de entrada

  • idstringObligatorio

    The MongoDB ObjectID of the contact to update

  • metaobject

    Contact variables from any source (ex. Salesforce) that are used for sequences and templates

  • namestring

    Name of the contact

  • emailstring

    Email address for the contact

  • contactIdstring

    Google ID that this contact is associated with

  • salesforceIdstring

    Salesforce ID for a contact or lead that this contact is associated with

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Contact GroupMIXMAX_UPDATE_CONTACT_GROUPAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The _id of the Contact Group to edit.

  • namestring

    Name for the Contact Group. Update this to change the group name.

  • expandstring

    Pass 'userId' to replace userId with _id and name in the response.

  • sharedobject[]

    Sharing settings with userEmail and accepted properties for each user.

  • teamIdsstring[]

    Array of team IDs to associate with the contact group.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Contact NoteMIXMAX_UPDATE_CONTACT_NOTEAcción

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.

Parámetros de entrada

  • textstringObligatorio

    The new text content for the note. The note will show "(edited)" in the UI after update.

  • expandstring

    Pass expand=userId to include the owner's name and email in the response.

  • note_idstringObligatorio

    The _id of the note for the contact to update.

  • contact_idstringObligatorio

    The _id of the contact the note belongs to. Only the creator of the note can edit it.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update insights reportMIXMAX_UPDATE_INSIGHTS_REPORTAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier (_id) of the insights report to update

  • typestringenum

    Enum for insights report types.

    messagesmeetingsgroupsuserssequencestemplatesdelegatorscustomers
  • querystring

    The report query to run

  • titlestring

    The title of the report (defaults to 'Untitled report' if not provided)

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Message by IDMIXMAX_UPDATE_MESSAGEAcción

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.

Parámetros de entrada

  • ccobject[]

    List of CC recipients to update.

  • idstringObligatorio

    The unique message identifier to update.

  • toobject[]

    List of primary recipients to update.

  • bccobject[]

    List of BCC recipients to update.

  • bodystring

    HTML formatted message content to update.

  • subjectstring

    Message subject line to update.

  • trackingEnabledboolean

    Whether email open tracking should be enabled for this message.

  • userHasModifiedboolean

    Whether the user has manually modified the message.

  • fileTrackingEnabledboolean

    Whether file download tracking should be enabled for this message.

  • linkTrackingEnabledboolean

    Whether link click tracking should be enabled for this message.

  • notificationsEnabledboolean

    Whether desktop notifications should be enabled for this message.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Sequence Folder by IDMIXMAX_UPDATE_SEQUENCE_FOLDERAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the sequence folder to update

  • namestring

    The name of the sequence folder to update

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Snippet TagMIXMAX_UPDATE_SNIPPET_TAGAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the snippet tag to update

  • namestring

    The name of the snippet tag (folder). Update this to rename the tag.

  • sharedobject

    Sharing configuration for the snippet tag. Pass sharing settings to control who can access the tag.

  • isInlineboolean

    Whether the snippet tag is inline. Set to true for inline tags, false otherwise.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update TeamMIXMAX_UPDATE_TEAMAcción

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.

Parámetros de entrada

  • idstringObligatorio

    The unique identifier of the team to update. Only admins can update team information.

  • namestringObligatorio

    The new name for the team.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not

Update Current User PreferencesMIXMAX_UPDATE_USER_PREFERENCES_MEAcción

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.

Parámetros de entrada

  • undoDelayinteger

    Delay in seconds before sending email (allows undo within this time).

  • appHotkeyMacstring

    Keyboard hotkey for Mac to open the app (e.g., 'Command+Shift+M').

  • appHotkeyWinstring

    Keyboard hotkey for Windows to open the app (e.g., 'Control+Shift+M').

  • emojiEnabledboolean

    Enable or disable emoji support in the compose window.

  • weekStartDayinteger

    Week start day for calendar view (0=Sunday, 1=Monday, 2=Tuesday, etc.).

  • defaultFontSizestring

    Default font size for compose window (e.g., 'small', 'medium', 'large').

  • defaultLocationstring

    Default location string for scheduled meetings.

  • undoSendEnabledboolean

    Enable or disable the undo send feature for emails.

  • defaultMeetingLengthinteger

    Default meeting length in milliseconds (e.g., 1800000 for 30 minutes).

  • preventDoubleBookingsboolean

    Prevent double bookings when scheduling meetings on calendar.

  • defaultTrackingEnabledboolean

    Enable or disable default tracking for emails.

  • slashCommandMenuEnabledboolean

    Enable or disable the slash command menu in compose.

  • autoLinkConversionEnabledboolean

    Enable or disable automatic link conversion when pasting URLs.

  • defaultFileTrackingEnabledboolean

    Enable or disable default file tracking for email attachments.

  • defaultLinkTrackingEnabledboolean

    Enable or disable default link tracking in emails.

  • defaultNotificationsEnabledboolean

    Enable or disable default notifications.

  • templateShortcutMenuEnabledboolean

    Enable or disable the template shortcut menu.

Parámetros de salida

  • dataobjectObligatorio

    Data from the action execution

  • errorstring

    Error if any occurred during the execution of the action

  • successfulbooleanObligatorio

    Whether or not the action execution was successful or not