Mailshake
API integration

list_all_mailshake_me

Get information about the current authenticated Mailshake user via the /me endpoint, which also serves as an authentication test. Returns: object, id, teamID, teamName, isTeamAdmin, isDisabled, emailAddress, fullName, first, last, teamBlockedDate.

list_all_mailshake_campaigns

List all Mailshake campaigns for a team. Returns each campaign with id, title, created, isArchived, isPaused, messages, sender, and url. An optional search filter narrows results by campaign title.

get_single_mailshake_campaign_by_id

Get a single Mailshake campaign by campaignID, including its full message sequence. Returns the campaign object with id, title, created, isArchived, isPaused, messages, sender, and url. Required: campaignID. A not_found error is returned if the campaign could not be found.

create_a_mailshake_campaign

Create a new campaign in Mailshake. The campaign cannot be sent until the user completes the setup wizard in Mailshake's UI, but recipients can be added immediately. Returns the created campaign object including id, title, created, isArchived, isPaused, messages, sender, and url.

mailshake_campaigns_pause

Pause all sending for a Mailshake campaign immediately. Emails in a batch currently being sent will not be stopped. Returns the campaign object including id, title, isPaused, isArchived, messages, and sender. Required: campaignID.

mailshake_campaigns_unpause

Resume sending for a paused Mailshake campaign. The team's sending calendar reschedules itself to account for this campaign's pending emails. Returns the campaign object including id, title, isPaused, isArchived, messages, and sender. Required: campaignID.

mailshake_campaigns_export

Start an asynchronous CSV export of one or more Mailshake campaigns. Returns: isEmpty, checkStatusID, code, error, time. Required: campaignIDs, exportType. timezone defaults to UTC.

mailshake_campaigns_export_status

Check the status of an asynchronous Mailshake campaign export. Returns: isFinished, csvDownloadUrl, code, error, time. When isFinished is true, csvDownloadUrl provides the downloadable CSV file. Required: statusID.

mailshake_recipients_add

Add new recipients to a Mailshake campaign using listOfEmails, addresses, or csvData. Returns: code, error, time. Required: campaignID. Each campaign can hold up to 5,000 recipients; at least one of listOfEmails, addresses, or csvData must be provided.

mailshake_recipients_add_status

Check the status of an asynchronous recipient import in Mailshake. Returns: isFinished, problems, code, error, time. Required: statusID.

list_all_mailshake_recipients

List recipients in a Mailshake campaign with optional search and activity-based filters. Returns: object, id, emailAddress, fullName, first, last, created, isPaused, contactID, fields. Required: campaignID.

get_single_mailshake_recipient_by_id

Get a single Mailshake recipient's basic information by recipient ID or campaign and email address. Returns: object, id, emailAddress, fullName, first, last, created, isPaused, contactID, fields, code, error, time. Required: recipientID, or campaignID and emailAddress. A not_found error is returned if the recipient could not be found.

mailshake_recipients_pause

Pause all sending for a single Mailshake recipient in a campaign. Returns the updated Recipient object including id, emailAddress, fullName, isPaused, created, and fields. Required: campaignID, emailAddress.

mailshake_recipients_unpause

Resume sending for a paused Mailshake recipient in a campaign. Returns the recipient object including id, emailAddress, fullName, isPaused, created, and fields. Required: campaignID, emailAddress. It may take up to 5 minutes for the sending calendar to reflect the change.

mailshake_recipients_unsubscribe

Unsubscribe a list of email addresses from Mailshake campaigns by adding them to your team's unsubscribe list. Returns an empty 204 response on success. Required: emailAddresses.

mailshake_activity_sent

List the most recently sent emails in Mailshake, including campaign sequence messages and one-off Lead Catcher replies. Returns paginated SentMessage objects with id, actionDate, recipient, campaign, type, subject, and body. Max 25 per page.

mailshake_activity_opens

List recently opened emails in Mailshake. Returns paginated Open models including id, actionDate, isDuplicate, recipient, campaign, and parent. Up to 100 results per page.

mailshake_activity_clicks

List the most recent link clicks in Mailshake campaigns. Returns paginated Click objects including id, link, actionDate, isDuplicate, contactID, recipient, campaign, and parent message. Max 100 per page.

mailshake_activity_replies

List recent replies to your sent emails in Mailshake, including bounces, out-of-office, and unsubscribe replies. Returns paginated Reply models with id, type, subject, body, recipient, campaign, and parent message. Max 25 per page.

mailshake_activity_created_leads

List the most recently created leads in Mailshake. Leads are usually created automatically by the rules configured in Lead Catcher, though users can also turn recipients into leads manually. Returns paginated Lead models with id, created, status, recipient, campaign and assignedTo. Filter with campaignID, recipientEmailAddress, assignedToEmailAddress, assignedToUserID or since.

mailshake_activity_lead_assignments

List the most recently assigned leads in Mailshake. Leads are assigned by members of your team assigning them manually. Returns paginated Lead models with id, created, assignedOnDate, assignedTo, status, recipient and campaign. Filter with campaignID, recipientEmailAddress, assignedToEmailAddress, assignedToUserID or since.

mailshake_activity_lead_status_changes

List the most recently updated leads in Mailshake. A lead can be opened, closed, ignored or reopened; a reopened lead shows open as its status, having previously been ignored or closed. Returns paginated Lead models with id, status, lastStatusChangeDate, recipient, campaign and assignedTo. Filter with campaignID, recipientEmailAddress, assignedToEmailAddress, assignedToUserID or since.

list_all_mailshake_leads

List Mailshake leads with optional filtering by campaign, status, assignee, or search term. Returns paginated Lead objects including id, status, created, openedDate, recipient, campaign, and assignedTo.

get_single_mailshake_lead_by_id

Get a single Mailshake lead. Returns the full Lead object including id, status, created, openedDate, recipient, campaign, and assignedTo. Specify one of leadID, recipientID, or emailAddress with campaignID.

create_a_mailshake_lead

Create new Mailshake leads from existing campaign recipients by specifying recipientIDs, emailAddresses, or both. Returns a CreatedLeads object including leads, emailsNotFound, invalidEmails, recipientIDsNotFound, and isEmpty. Costs 25 quota units.

mailshake_leads_close

Close a Mailshake lead by marking it as 'closed' or 'lost'. Returns an empty response on success. Costs 5 quota units. Defaults to 'closed' status.

mailshake_leads_ignore

Ignore a Mailshake lead to mark it as not worth pursuing. Returns a LeadStatus object including status and leadID. Costs 5 quota units.

mailshake_leads_reopen

Reopen a closed or ignored Mailshake lead, making it open again and available for review. Returns: status, leadID, code, error, time. Costs 5 quota units.

mailshake_team_list_members

List all members of a Mailshake team. Returns paginated User models including id, emailAddress, fullName, isTeamAdmin, teamName, and teamBlockedDate.

list_all_mailshake_senders

List all of a team's senders available for campaigns in Mailshake. Returns paginated Sender models including object, id, emailAddress, fromName, and created. No required parameters.

create_a_mailshake_push

Create a push/webhook subscription in Mailshake to receive POST notifications for specific events such as clicks, opens, replies, and lead status changes. Returns: targetUrl, resource_url, code, error, time. Required: targetUrl, event. Costs 100 quota units.

delete_a_mailshake_push_by_id

Delete a Mailshake push/webhook subscription by its target URL. Unsubscribes a push you previously created; since all subscribed pushes require a unique targetUrl, that is the only parameter needed. Returns an empty 204 response on success. Required: targetUrl.