Skip to main content
New to Corsair? See API access, authentication, and error handling.

getMe

appointmentLinks.getMe Get the user’s default Mixmax appointment link. Risk: read
Input: empty object Output

list

appointmentLinks.list Search the user’s Mixmax appointment links by name. Risk: read
Input Output: object[]

updateMe

appointmentLinks.updateMe Rename the user’s default Mixmax appointment link. Risk: write
Input Output: undefined

Code Snippets

create

codeSnippets.create Create a Mixmax code snippet. Risk: write
Input Output

get

codeSnippets.get Retrieve one Mixmax code snippet by id. Risk: read
Input Output

list

codeSnippets.list List the user’s Mixmax code snippets. Risk: read
Input Output

File Requests

get

fileRequests.get Retrieve one Mixmax file request by id. Risk: read
Input Output

list

fileRequests.list List the Mixmax file requests the user has access to. Risk: read
Input Output

Insights Reports

create

insightsReports.create Create a saved Mixmax insights report from a query. Risk: write
Input Output

delete

insightsReports.delete Delete a saved Mixmax insights report permanently. Risk: destructive
Input Output: undefined

list

insightsReports.list List the user’s saved Mixmax insights reports. Risk: read
Input Output

update

insightsReports.update Update a saved Mixmax insights report. Risk: write
Input Output

Integrations

commands.create

integrations.commands.create Create a Mixmax slash command integration. Risk: write
Input Output

commands.delete

integrations.commands.delete Delete a Mixmax slash command integration. Risk: destructive
Input Output: undefined

commands.list

integrations.commands.list List the user’s Mixmax slash command integrations. Risk: read
Input Output

enhancements.create

integrations.enhancements.create Create a Mixmax enhance-menu integration. Risk: write
Input Output

enhancements.delete

integrations.enhancements.delete Delete a Mixmax enhance-menu integration. Risk: destructive
Input Output: undefined

enhancements.list

integrations.enhancements.list List the user’s Mixmax enhance-menu integrations. Risk: read
Input Output

linkResolvers.create

integrations.linkResolvers.create Create a Mixmax link resolver integration. Risk: write
Input Output

linkResolvers.delete

integrations.linkResolvers.delete Delete a Mixmax link resolver integration. Risk: destructive
Input Output: undefined

linkResolvers.list

integrations.linkResolvers.list List the user’s Mixmax link resolver integrations. Risk: read
Input Output

integrations.sidebars.create Create a Mixmax sidebar integration. Risk: write
Input Output
integrations.sidebars.delete Delete a Mixmax sidebar integration. Risk: destructive
Input Output: undefined
integrations.sidebars.list List the user’s Mixmax sidebar integrations. Risk: read
Input: empty object Output

Livefeed

events

livefeed.events List individual Mixmax live feed events such as opens, clicks, and replies. Risk: read
Input Output

list

livefeed.list List the user’s Mixmax live feed of tracked email activity, with optional stats. Risk: read
Input Output

Meeting Invites

get

meetingInvites.get Retrieve one Mixmax meeting invite by id. Risk: read
Input Output

list

meetingInvites.list List the Mixmax meeting invites sent to the user. Risk: read
Input Output

Meetings

getTranscript

meetings.getTranscript Retrieve the transcript of one Mixmax meeting. Risk: read
Input Output

searchSummaries

meetings.searchSummaries Search Mixmax meeting summaries by attendee, title, and date range. Risk: read
Input Output

Meeting Types

create

meetingTypes.create Create a Mixmax meeting template. Risk: write
Input
Output

delete

meetingTypes.delete Delete a Mixmax meeting template permanently. Risk: destructive
Input Output: undefined

get

meetingTypes.get Retrieve one Mixmax meeting template by id. Risk: read
Input Output

list

meetingTypes.list List the user’s Mixmax meeting templates. Risk: read
Input Output

update

meetingTypes.update Update a Mixmax meeting template. Risk: write
Input
Output: empty object

Messages

create

messages.create Create a Mixmax draft message without sending it. Risk: write
Input
Output

get

messages.get Retrieve one Mixmax message by id. Risk: read
Input Output

list

messages.list List Mixmax messages (drafts, scheduled, sent, or failed), newest first. Risk: read
Input Output

schedule

messages.schedule Schedule a saved Mixmax draft: Mixmax emails its recipients at the given Unix-millisecond timestamp unless the send is unscheduled first. Risk: write
Input
Output: string \| undefined

send

messages.send Send a saved Mixmax draft: this emails its recipients. Delivery is asynchronous and cannot be undone. Risk: write
Input
Output: empty object

sendPlain

messages.sendPlain Send a plain email from the user’s mailbox to its recipients immediately, outside Mixmax tracking. It cannot be undone. Risk: write
Input
Output: undefined

test

messages.test Send a Mixmax test email to the calling user’s own account. Risk: write
Input Output: empty object

unschedule

messages.unschedule Cancel a scheduled Mixmax send and return the message to draft. Risk: write
Input Output: string \| undefined

update

messages.update Update the fields of a sent Mixmax message; each included field replaces the stored value. Risk: write
Input
Output: undefined

Polls

get

polls.get Retrieve one Mixmax poll by id. Risk: read
Input Output

list

polls.list List the user’s Mixmax polls with their response counts. Risk: read
Input Output

Qa

get

qa.get Retrieve one Mixmax Q&A form by id. Risk: read
Input Output

list

qa.list List the user’s Mixmax Q&A forms with their answers. Risk: read
Input Output

Reports

runDataTable

reports.runDataTable Run a Mixmax reporting query and return the aggregated data table buckets. Risk: read
Input Output

Rules

actions.create

rules.actions.create Add an action to a Mixmax rule. Risk: write
Input Output

actions.delete

rules.actions.delete Remove one action from a Mixmax rule. Risk: destructive
Input Output: undefined

actions.list

rules.actions.list List the actions of one Mixmax rule. Risk: read
Input Output

actions.update

rules.actions.update Update one action of a Mixmax rule. Risk: write
Input Output

create

rules.create Create a Mixmax rule with a trigger and actions. Risk: write
Input
Output

delete

rules.delete Delete a Mixmax rule permanently. Risk: destructive
Input Output: undefined

deleteBulk

rules.deleteBulk Delete several Mixmax rules at once by their ids. Risk: destructive
Input Output: undefined

events.get

rules.events.get Retrieve one Mixmax rule event by id. Risk: read
Input Output

events.list

rules.events.list List Mixmax rule events with their status, filterable by rule and outcome. Risk: read
Input Output

get

rules.get Retrieve one Mixmax rule by id. Risk: read
Input Output

list

rules.list List the user’s Mixmax rules, optionally with their actions. Risk: read
Input Output

update

rules.update Update the trigger or fields of a Mixmax rule. Risk: write
Input
Output

Salesforce

createAccount

salesforce.createAccount Create a Salesforce account through Mixmax. Risk: write
Input Output

createContact

salesforce.createContact Create a Salesforce contact through Mixmax. Risk: write
Input Output

createLead

salesforce.createLead Create a Salesforce lead through Mixmax. Risk: write
Input Output

createOpportunity

salesforce.createOpportunity Create a Salesforce opportunity through Mixmax. Risk: write
Input Output

createTask

salesforce.createTask Create a Salesforce task through Mixmax. Risk: write
Input Output

deleteOpportunity

salesforce.deleteOpportunity Delete a Salesforce opportunity through Mixmax. Risk: destructive
Input Output: undefined

deleteTask

salesforce.deleteTask Delete a Salesforce task through Mixmax. Risk: destructive
Input Output

getAccount

salesforce.getAccount Retrieve one Salesforce account synced to Mixmax. Risk: read
Input Output: object \| undefined

getAccountImplicit

salesforce.getAccountImplicit Look up the Salesforce account matching an email domain. Risk: read
Input Output: object \| undefined

getContact

salesforce.getContact Retrieve one Salesforce contact synced to Mixmax. Risk: read
Input Output: object \| undefined

getContactOrLead

salesforce.getContactOrLead Look up the Salesforce contact or lead matching an email address. Risk: read
Input Output: object \| undefined

getLead

salesforce.getLead Retrieve one Salesforce lead synced to Mixmax. Risk: read
Input Output: object \| undefined

getOpportunity

salesforce.getOpportunity Retrieve one Salesforce opportunity synced to Mixmax. Risk: read
Input Output: object \| undefined

getTask

salesforce.getTask Retrieve one Salesforce task synced to Mixmax. Risk: read
Input Output: object \| undefined

getWhat

salesforce.getWhat Resolve any Salesforce record id to its related “what” object. Risk: read
Input Output: object \| undefined

getWho

salesforce.getWho Resolve any Salesforce record id to its related “who” object. Risk: read
Input Output: object \| undefined

listAccounts

salesforce.listAccounts List the Salesforce accounts synced to the user’s Mixmax. Risk: read
Input Output

listContactTasks

salesforce.listContactTasks List the Salesforce tasks of one contact. Risk: read
Input Output

listLeadTasks

salesforce.listLeadTasks List the Salesforce tasks of one lead. Risk: read
Input Output

salesforce.search Search Salesforce records of one object type through Mixmax. Risk: read
Input Output

syncedFields

salesforce.syncedFields List the Salesforce fields Mixmax syncs for each object type. Risk: read
Input Output: object

updateAccount

salesforce.updateAccount Update a Salesforce account through Mixmax. Risk: write
Input Output

updateContact

salesforce.updateContact Update a Salesforce contact through Mixmax. Risk: write
Input Output

updateLead

salesforce.updateLead Update a Salesforce lead through Mixmax. Risk: write
Input Output

updateOpportunity

salesforce.updateOpportunity Update a Salesforce opportunity through Mixmax. Risk: write
Input Output

updateTask

salesforce.updateTask Update a Salesforce task through Mixmax. Risk: write
Input Output

Sequence Folders

addSequences

sequenceFolders.addSequences Move one or more Mixmax sequences into a sequence folder. Risk: write
Input Output: object \| object[]

create

sequenceFolders.create Create a Mixmax sequence folder. Risk: write
Input
Output

delete

sequenceFolders.delete Delete a Mixmax sequence folder; its sequences are kept but left without a folder. Risk: destructive
Input Output: undefined

get

sequenceFolders.get Retrieve one Mixmax sequence folder by id. Risk: read
Input Output

list

sequenceFolders.list List the Mixmax sequence folders the user can access. Risk: read
Input: empty object Output

rename

sequenceFolders.rename Rename a Mixmax sequence folder. Risk: write
Input
Output

Sequences

cancel

sequences.cancel Stop recipients of one Mixmax sequence; cancellation is one-way and deletes their open tasks. Risk: destructive
Input Output

cancelAll

sequences.cancelAll Stop the user’s recipients across every Mixmax sequence at once; cancelled recipients cannot be resumed. Risk: destructive
Input Output

list

sequences.list List the Mixmax sequences the user can access, including shared ones. Risk: read
Input Output

recipients.add

sequences.recipients.add Add recipients to a Mixmax sequence: this starts emailing them the sequence unless each recipient is kept as a draft with scheduledAt false. Risk: write
Input
Output

recipients.list

sequences.recipients.list List the recipients of one Mixmax sequence with their per-stage activity. Risk: read
Input Output: object[]

search

sequences.search Search sequence recipients across every accessible Mixmax sequence with their status and activity. Risk: read
Input Output

Snippets

delete

snippets.delete Move a Mixmax template to the trash, or archive it, removing it from its folders. Risk: destructive
Input Output: undefined

get

snippets.get Retrieve one Mixmax template by id. Risk: read
Input Output

list

snippets.list List the Mixmax templates (snippets) the user can access, including shared ones. Risk: read
Input Output

send

snippets.send Send an email built from a Mixmax template to its recipients, immediately or at a scheduled time. Risk: write
Input
Output: undefined

update

snippets.update Update the fields of a Mixmax template; only the fields sent change. Risk: write
Input
Output

Snippet Tags

addSnippets

snippetTags.addSnippets Add a template to a Mixmax template folder. Risk: write
Input
Output

create

snippetTags.create Create a Mixmax template folder. Risk: write
Input
Output

delete

snippetTags.delete Delete a Mixmax template folder and move every template inside it to the trash. Risk: destructive
Input Output: undefined

get

snippetTags.get Retrieve one Mixmax template folder by id. Risk: read
Input Output

list

snippetTags.list List the Mixmax template folders (snippet tags) the user can access. Risk: read
Input Output

listSnippets

snippetTags.listSnippets List the templates contained in one Mixmax template folder. Risk: read
Input Output

update

snippetTags.update Rename a Mixmax template folder. Risk: write
Input
Output

Tasks

list

tasks.list List the user’s open Mixmax tasks. Risk: read
Input Output

Teams

create

teams.create Create a Mixmax team. Risk: write
Input
Output

delete

teams.delete Delete a Mixmax team permanently. Risk: destructive
Input Output: undefined

get

teams.get Retrieve one Mixmax team by id. Risk: read
Input Output

list

teams.list List the user’s Mixmax teams. Risk: read
Input Output

members.add

teams.members.add Add people to a Mixmax team; Mixmax emails each of them an invite. Risk: write
Input
Output: object[]

members.list

teams.members.list List the members of one Mixmax team. Risk: read
Input Output

members.remove

teams.members.remove Remove one member from a Mixmax team. Risk: destructive
Input Output: boolean

members.update

teams.members.update Change a Mixmax team member’s role. Risk: write
Input Output: boolean

update

teams.update Rename a Mixmax team. Risk: write
Input Output: string

Unsubscribes

create

unsubscribes.create Add one or more email addresses to the Mixmax unsubscribe list. Risk: write
Input Output: undefined

list

unsubscribes.list List the email addresses unsubscribed from the user’s Mixmax sends. Risk: read
Input Output

remove

unsubscribes.remove Remove one email address from the Mixmax unsubscribe list. Risk: destructive
Input Output: undefined

Users

getMe

users.getMe Get the current Mixmax user. Risk: read
Input: empty object Output

preferences.autoBccExcludedEmails.add

users.preferences.autoBccExcludedEmails.add Add email addresses to the user’s Mixmax auto BCC exclusion list. Risk: write
Input Output

preferences.autoBccExcludedEmails.exists

users.preferences.autoBccExcludedEmails.exists Check exactly which email addresses are excluded from the user’s Mixmax auto BCC list, including role exclusions. Risk: read
Input Output: object[]

preferences.autoBccExcludedEmails.list

users.preferences.autoBccExcludedEmails.list Check whether one email address is excluded from the user’s Mixmax auto BCC list. Risk: read
Input Output: string \| undefined

preferences.get

users.preferences.get Get the calling user’s Mixmax preferences. Risk: read
Input Output: empty object

preferences.update

users.preferences.update Update the calling user’s Mixmax preferences. Risk: write
Input: empty object Output: empty object

Yesno

get

yesno.get Retrieve one Mixmax yes/no question by id. Risk: read
Input Output

list

yesno.list List the user’s Mixmax yes/no questions with their answers. Risk: read
Input Output