/mixmax | Type: Application | PCID required: Yes
Tools
mixmax_add_sequence_recipients
Add recipients to a sequence Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The sequence ID. |
recipients | object[] | Yes | — | Array of recipient objects to add to the sequence. |
mixmax_check_appointment_link_availability
Check appointment link availability Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The calendar link name to check availability for. |
mixmax_create_code_snippet
Create a code snippet Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
background | string | Yes | — | Background color in format rgb(0-255, 0-255, 0-255). |
html | string | Yes | — | The HTML of your code snippet. |
language | string | Yes | — | Programming language for syntax highlighting. |
theme | string | Yes | — | Code editor theme. |
title | string | No | — | Title of the code snippet. |
mixmax_create_insights_report
Create an insights report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | Report query string. |
title | string | No | — | Title of the report. |
type | string | Yes | — | Type of report. |
mixmax_create_live_feed_search
Create a live feed search Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | Yes | — | The query string that the search performs. |
title | string | No | — | Title of the saved search. |
mixmax_create_message
Create a draft message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
bcc | object[] | No | — | Recipients in the BCC field. |
body | string | No | — | The HTML body of the message. |
cc | object[] | No | — | Recipients in the CC field. |
fileTrackingEnabled | boolean | No | — | Enable file download tracking. |
inReplyTo | string | No | — | Gmail message ID for threading replies. |
linkTrackingEnabled | boolean | No | — | Enable link click tracking. |
notificationsEnabled | boolean | No | — | Enable notifications. |
subject | string | No | — | The message subject line. |
to | object[] | No | — | Recipients in the To field. |
trackingEnabled | boolean | No | — | Enable open tracking. |
userHasModified | boolean | No | — | Set to true to create a Gmail draft. |
mixmax_delete_enhancement
Delete an enhancement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The enhancement ID. |
mixmax_get_code_snippet
Get a code snippet Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The code snippet ID. |
mixmax_get_enhancement
Get an enhancement Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The enhancement ID. |
mixmax_get_file_request
Get a file request Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The file request ID. |
mixmax_get_live_feed
Get live feed Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
query | string | No | — | The query to execute. Takes the same format as queries in the live feed UI. |
timezone | string | No | — | RFC timezone descriptor (e.g. America/Los_Angeles). Defaults to UTC. |
limit | integer | No | — | Maximum number of results to return (max 10000). Default 50. |
offset | integer | No | — | Offset for pagination. Default 0. |
stats | boolean | No | — | Whether to return aggregate stats. Default true. |
mixmax_get_live_feed_events
Get live feed events Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
messageId | string | No | — | The message ID to fetch events for. |
contactEmail | string | No | — | The contact email to fetch events for. |
wasSentViaMixmax | boolean | Yes | — | Whether the message was sent via Mixmax. |
includeTeammates | boolean | No | — | Whether to include events from teammates. |
mixmax_get_message
Get a message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The message ID. |
mixmax_get_my_appointment_link
Get my appointment linkmixmax_get_poll
Get a poll Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The poll ID. |
mixmax_get_user_info
Get current user infomixmax_list_code_snippets
List code snippetsmixmax_list_enhancements
List enhancementsmixmax_list_file_requests
List file requestsmixmax_list_insights_reports
List insights reportsmixmax_list_integration_commands
List slash commandsmixmax_list_live_feed_searches
List live feed searchesmixmax_list_meeting_types
List meeting typesmixmax_list_messages
List messagesmixmax_list_polls
List pollsmixmax_list_rules
List rules Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
expand | string | No | — | Pass ‘actions’ to return rule actions as an array. |
mixmax_list_sent_sequences
List sent sequence statsmixmax_list_sequence_recipients
List sequence recipients Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The sequence ID. |
filter | string | No | — | Filter recipients by status (e.g. ‘active’, ‘paused’, ‘finished’). |
mixmax_list_sequences
List sequences Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | No | — | Returns sequences that match this string. |
expand | string | No | — | Pass ‘stages’ to return information about the stages too. |
folder | string | No | — | Filter by folder. Use ‘shared’ for shared sequences, ‘personal’ for personal, or a specific folder ID. |
mixmax_list_unsubscribes
List unsubscribes Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
sort | string | No | — | Field to sort by: name, email, or createdAt. |
sortAscending | boolean | No | — | Sort in ascending order. |
next | string | No | — | Pagination token for next page. |
previous | string | No | — | Pagination token for previous page. |
limit | integer | No | — | Maximum number of records to return. Default 50. |
mixmax_query_report_data
Query report data Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
fields | string | No | — | Comma-delimited list of fields to return. |
groupBy | string | No | — | Field to group results by. |
limit | integer | No | — | Maximum number of results (max 10000). Default 1000. |
offset | integer | No | — | Offset for pagination. Default 0. |
query | string | No | — | Query string to filter results (e.g. ‘sent:last30days from:everyone’). |
sortBy | string | No | — | Field to sort results by. |
sortDesc | boolean | No | — | Sort in descending order. Default true. |
timezone | string | No | — | Client timezone. Default UTC. |
type | string | Yes | — | The type of data to query. |
mixmax_send_message
Send a message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The message ID to send. |
data | object | No | — | Message properties to update prior to sending. |
options | object | No | — | Sending options. |
mixmax_send_test_message
Send a test message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
body | string | Yes | — | The HTML body of the test message. |
subject | string | Yes | — | The subject line of the test message. |
mixmax_update_code_snippet
Update a code snippet Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The code snippet ID to update. |
background | string | No | — | Background color in format rgb(0-255, 0-255, 0-255). |
html | string | No | — | The HTML of your code snippet. |
language | string | No | — | Programming language for syntax highlighting. |
theme | string | No | — | Code editor theme. |
title | string | No | — | Title of the code snippet. |
mixmax_update_insights_report
Update an insights report Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The insights report ID. |
query | string | No | — | Report query string. |
title | string | No | — | Title of the report. |
type | string | No | — | Type of report. |
mixmax_update_live_feed_search
Update a live feed search Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The live feed search ID. |
query | string | No | — | The query string that the search performs. |
title | string | No | — | Title of the saved search. |
mixmax_update_meeting_type
Update a meeting type Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The meeting type ID. |
buffer | integer | No | — | Buffer time between meetings in minutes (0-60). |
daysFromNow | object | No | — | Time window for availability with start and end days. |
defaults | object | No | — | Default calendar event properties. |
durationMin | integer | No | — | Duration of the meeting in minutes. |
name | string | No | — | The name of the meeting type. |
mixmax_update_message
Update a message Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
id | string | Yes | — | The message ID. |
bcc | object[] | No | — | Recipients in the BCC field. |
body | string | No | — | The HTML body of the message. |
cc | object[] | No | — | Recipients in the CC field. |
fileTrackingEnabled | boolean | No | — | Enable file download tracking. |
inReplyTo | string | No | — | Gmail message ID for threading replies. |
linkTrackingEnabled | boolean | No | — | Enable link click tracking. |
notificationsEnabled | boolean | No | — | Enable notifications. |
subject | string | No | — | The message subject line. |
to | object[] | No | — | Recipients in the To field. |
trackingEnabled | boolean | No | — | Enable open tracking. |
userHasModified | boolean | No | — | Set to true to create a Gmail draft. |
mixmax_update_my_appointment_link
Update my appointment link Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
name | string | Yes | — | The new calendar vanity URL name. |

