The Litmus connector lets your AI agent work with Litmus. Scalekit handles authentication for every call, so your agent never handles credentials. It comes with 67 tools.
- Tools
- 67
- What they doRead · write · destructive
- 40 · 24 · 340 read24 write3 destructive
- Users sign in with
- Username and password
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Litmus connection
In AgentKit > Connections, create a Litmus connection. The name you give it is the
connection_nameyour code passes. See Configure connections.
Tools
Pass the exact name toexecute_toollitmus_accessibility_check_getGet the results of accessibility checks on an email.Read-onlyGet Accessibility Check Results
Get the results of accessibility checks on an email. Returns meta.state (pending or complete) and, when complete, the number of checks, the passes and the failures with rule, description, standards (for example WCAG 2AA), impact and the offending HTML snippets. Use litmus_accessibility_check_get to poll after litmus_accessibility_check_create. Polling while pending does not count against the rate limit. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
email_guidstringrequired- GUID returned by litmus_accessibility_check_create. Example: 5c0e3f6a-0b8e-4d0f-9c55-2f1b8a7d9e10.
litmus_analytics_activity_report_getGet the activity report (opens over time) for an Email Analytics campaign.Read-onlyGet Campaign Activity Report
Get the activity report (opens over time) for an Email Analytics campaign. Returns activity report (opens over time) built from the campaign's tracking pixel opens. Use litmus_analytics_activity_report_get to see when opens happened. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_activity_summary_report_getGet the activity summary (totals, uniques and first and last opens) for an Email Analytics campaign.Read-onlyGet Campaign Activity Summary
Get the activity summary (totals, uniques and first and last opens) for an Email Analytics campaign. Returns activity summary (totals, uniques and first and last opens) built from the campaign's tracking pixel opens. Use litmus_analytics_activity_summary_report_get for headline numbers. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_browser_usage_report_getGet the browser usage for webmail opens for an Email Analytics campaign.Read-onlyGet Campaign Browser Usage
Get the browser usage for webmail opens for an Email Analytics campaign. Returns browser usage for webmail opens built from the campaign's tracking pixel opens. Use litmus_analytics_browser_usage_report_get to see which browsers webmail readers use. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_campaigns_compareCompare key metrics across a set of campaigns.Read-onlyCompare Analytics Campaigns
Compare key metrics across a set of campaigns. Returns a comparable report with opens, engagement and client shares per campaign. Use litmus_analytics_campaigns_compare to benchmark campaigns against each other. Uses the Basic (API key and passphrase) connection.
Inputs
guidsarrayrequired- Campaign GUIDs to include, from litmus_analytics_campaign_create. Example: ["8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d"].
litmus_analytics_campaigns_getGet campaign details for a set of campaign GUIDs.Read-onlyGet Analytics Campaigns
Get campaign details for a set of campaign GUIDs. Returns each campaign's name, status, dates, expiry, open totals and tracking code. Use litmus_analytics_campaigns_get for campaign details. Use the report tools for breakdowns. Uses the Basic (API key and passphrase) connection.
Inputs
guidsarrayrequired- Campaign GUIDs to include, from litmus_analytics_campaign_create. Example: ["8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d"].
litmus_analytics_detailed_engagement_report_getGet the detailed engagement report (engagement by reading-time bucket) for an Email Analytics campaign.Read-onlyGet Campaign Detailed Engagement Report
Get the detailed engagement report (engagement by reading-time bucket) for an Email Analytics campaign. Returns detailed engagement report (engagement by reading-time bucket) built from the campaign's tracking pixel opens. Use litmus_analytics_detailed_engagement_report_get for reading-time detail. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_detailed_mail_client_engagement_report_getGet the detailed engagement per email client for an Email Analytics campaign.Read-onlyGet Campaign Detailed Mail Client Engagement
Get the detailed engagement per email client for an Email Analytics campaign. Returns detailed engagement per email client built from the campaign's tracking pixel opens. Use litmus_analytics_detailed_mail_client_engagement_report_get for per-client reading-time detail. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_engagement_report_getGet the engagement report (read, skimmed and glanced shares) for an Email Analytics campaign.Read-onlyGet Campaign Engagement Report
Get the engagement report (read, skimmed and glanced shares) for an Email Analytics campaign. Returns engagement report (read, skimmed and glanced shares) built from the campaign's tracking pixel opens. Use litmus_analytics_engagement_report_get to see how long recipients read. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_expiring_campaigns_listList the GUIDs of campaigns that expire on or before a date.Read-onlyList Expiring Analytics Campaigns
List the GUIDs of campaigns that expire on or before a date. Returns campaign GUIDs with their expiry dates. Use litmus_analytics_expiring_campaigns_list to find campaigns to extend with litmus_analytics_campaign_expiration_set. Uses the Basic (API key and passphrase) connection.
Inputs
until_datestringrequired- Date to look ahead to (YYYY-MM-DD). Example: 2026-10-31.
litmus_analytics_geolocation_report_getGet the opens by country and region (needs TrackGeolocation) for an Email Analytics campaign.Read-onlyGet Campaign Geolocation Report
Get the opens by country and region (needs TrackGeolocation) for an Email Analytics campaign. Returns opens by country and region (needs TrackGeolocation) built from the campaign's tracking pixel opens. Use litmus_analytics_geolocation_report_get to see where opens come from. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_group_engagement_report_getGet the engagement by client group (desktop, mobile, webmail) for an Email Analytics campaign.Read-onlyGet Campaign Group Engagement Report
Get the engagement by client group (desktop, mobile, webmail) for an Email Analytics campaign. Returns engagement by client group (desktop, mobile, webmail) built from the campaign's tracking pixel opens. Use litmus_analytics_group_engagement_report_get to compare engagement by environment. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_group_usage_report_getGet the usage by client group (desktop, mobile, webmail) for an Email Analytics campaign.Read-onlyGet Campaign Group Usage
Get the usage by client group (desktop, mobile, webmail) for an Email Analytics campaign. Returns usage by client group (desktop, mobile, webmail) built from the campaign's tracking pixel opens. Use litmus_analytics_group_usage_report_get for environment shares. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_mail_client_engagement_report_getGet the engagement per email client (user agent level) for an Email Analytics campaign.Read-onlyGet Campaign Mail Client Engagement
Get the engagement per email client (user agent level) for an Email Analytics campaign. Returns engagement per email client (user agent level) built from the campaign's tracking pixel opens. Use litmus_analytics_mail_client_engagement_report_get to compare reading time by client. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_mail_client_usage_report_getGet the mail client usage (opens per email client) for an Email Analytics campaign.Read-onlyGet Campaign Mail Client Usage
Get the mail client usage (opens per email client) for an Email Analytics campaign. Returns mail client usage (opens per email client) built from the campaign's tracking pixel opens. Use litmus_analytics_mail_client_usage_report_get to see which clients your audience uses. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_open_counts_by_month_getGet open counts for a set of campaigns in one calendar month.Read-onlyGet Campaign Open Counts for a Month
Get open counts for a set of campaigns in one calendar month. Returns open counts per campaign for that month. Use litmus_analytics_open_counts_by_month_get for one month. Use litmus_analytics_open_counts_by_period_get for any range. Uses the Basic (API key and passphrase) connection.
Inputs
guidsarrayrequired- Campaign GUIDs to include, from litmus_analytics_campaign_create. Example: ["8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d"].
monthstringrequired- Month number, 1 to 12. Example: 10.
yearstringrequired- Four-digit year. Example: 2026.
litmus_analytics_open_counts_by_period_getGet open counts for a set of campaigns between two dates.Read-onlyGet Campaign Open Counts for a Period
Get open counts for a set of campaigns between two dates. Returns open counts per campaign for the period. Use litmus_analytics_open_counts_by_period_get for a custom range. Uses the Basic (API key and passphrase) connection.
Inputs
from_datestringrequired- Start date (YYYY-MM-DD). Example: 2026-10-01.
guidsarrayrequired- Campaign GUIDs to include, from litmus_analytics_campaign_create. Example: ["8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d"].
until_datestringrequired- End date (YYYY-MM-DD). Example: 2026-10-31.
litmus_analytics_open_counts_getGet open counts for a set of campaigns.Read-onlyGet Campaign Open Counts
Get open counts for a set of campaigns. Returns total and unique open counts per campaign. Use litmus_analytics_open_counts_get for current totals. Use litmus_analytics_open_counts_by_period_get for a date range. Uses the Basic (API key and passphrase) connection.
Inputs
guidsarrayrequired- Campaign GUIDs to include, from litmus_analytics_campaign_create. Example: ["8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d"].
litmus_analytics_open_counts_monthly_getGet open counts for a set of campaigns broken down by month.Read-onlyGet Campaign Open Counts by Month
Get open counts for a set of campaigns broken down by month. Returns one row per campaign and month with open counts. Use litmus_analytics_open_counts_monthly_get for month-by-month trends. Uses the Basic (API key and passphrase) connection.
Inputs
guidsarrayrequired- Campaign GUIDs to include, from litmus_analytics_campaign_create. Example: ["8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d"].
litmus_analytics_rendering_category_report_getGet the opens by rendering engine category for an Email Analytics campaign.Read-onlyGet Campaign Rendering Engine Report
Get the opens by rendering engine category for an Email Analytics campaign. Returns opens by rendering engine category built from the campaign's tracking pixel opens. Use litmus_analytics_rendering_category_report_get to prioritize which rendering engines to design for. Use litmus_analytics_campaigns_get for campaign status and totals. Uses the Basic (API key and passphrase) connection.
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_user_open_counts_by_month_getGet the open counts of every campaign of one end user in a month.Read-onlyGet User Open Counts for a Month
Get the open counts of every campaign of one end user in a month. Returns open counts per campaign for that user and month. Use litmus_analytics_user_open_counts_by_month_get for monthly usage per user. Uses the Basic (API key and passphrase) connection.
Inputs
month_datestringrequired- Any date in the month (YYYY-MM-DD). Example: 2026-10-01.
user_guidstringrequired- Your own GUID for the end user, as used when creating their campaigns. Example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301.
litmus_analytics_user_open_counts_by_period_getGet the open counts of every campaign of one end user between two dates.Read-onlyGet User Open Counts for a Period
Get the open counts of every campaign of one end user between two dates. Returns open counts per campaign for that user and period. Use litmus_analytics_user_open_counts_by_period_get for one of your users' usage. Use litmus_analytics_user_open_counts_by_month_get for a month. Uses the Basic (API key and passphrase) connection.
Inputs
from_datestringrequired- Start date (YYYY-MM-DD). Example: 2026-10-01.
until_datestringrequired- End date (YYYY-MM-DD). Example: 2026-10-31.
user_guidstringrequired- Your own GUID for the end user, as used when creating their campaigns. Example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301.
litmus_email_test_getGet an email preview test with its results.Read-onlyGet Email Preview Test
Get an email preview test with its results. Returns State (waiting, processing, complete or error), InboxGuid and each testing application's result with completion state and screenshot image URLs (window and full page, images on and off), and spam scores for spam results. Use litmus_email_test_get to poll a test (start at 3 s and back off to 30 s). Use litmus_test_result_get for one application's result. Uses the Basic (API username and password) connection.
Inputs
test_idintegerrequired- Id of the email test, from litmus_email_test_create. Example: 1.
litmus_guardian_email_result_getGet the latest Email Guardian monitoring result for an enrolled email.Read-onlyGet Email Guardian Result
Get the latest Email Guardian monitoring result for an enrolled email. Returns, per email client, a screenshot URL and change level (major, minor or noChange), per link the destination, screenshot, status (ok or broken) and error, and checked-at. Use litmus_guardian_email_result_get to see whether rendering or links changed. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
email_idstringrequired- ID of the enrolled Email Guardian email, from litmus_guardian_email_enroll or litmus_guardian_emails_list. Example: 11.
litmus_guardian_emails_listList every email enrolled in Email Guardian.Read-onlyList Email Guardian Emails
List every email enrolled in Email Guardian. Returns enrolled emails with their IDs, plus first and last page links. Use litmus_guardian_emails_list for all users. Use litmus_guardian_user_emails_list for one integration user. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page (default 20). Example: 20.
litmus_guardian_user_emails_listList the emails one integration user has enrolled in Email Guardian.Read-onlyList Integration User's Guardian Emails
List the emails one integration user has enrolled in Email Guardian. Returns that user's enrolled emails with their IDs, plus page links. Use litmus_guardian_user_emails_list for one end user. Use litmus_guardian_emails_list for everyone. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
integration_user_idstringrequired- ID of the integration user (your end user) you act for, from litmus_integration_user_create. Example: 1.
page_numberinteger- Page number, starting at 1. Example: 1.
page_sizeinteger- Results per page (default 20). Example: 20.
litmus_link_test_getGet a link check test's results.Read-onlyGet Link Check Test
Get a link check test's results. Returns State and each link with Url, IsValid, Exception, IsBlackListed, HasGoogleAnalytics and its parameters, HasClickTracking, the destination page title and a thumbnail. Use litmus_link_test_get to poll a link check started with litmus_link_test_create. Uses the Basic (API username and password) connection.
Inputs
link_test_idintegerrequired- Id of the link test, from litmus_link_test_create. Example: 1.
litmus_personalize_calendar_event_previewRender a preview of a Litmus Personalize calendar event while you adjust its settings; nothing is published.Read-onlyPreview Calendar Event
Render a preview of a Litmus Personalize calendar event while you adjust its settings; nothing is published. Returns a button image URL and add-to-calendar links (ics, Google, Outlook, Apple, AOL, Yahoo). Use litmus_personalize_calendar_event_preview while designing. Use litmus_personalize_calendar_event_publish for the version that goes in the email. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The calendar event settings, sent as data.attributes. Give templateId, event (title, startDatetime, endDatetime unless allDay, description, location, allDay) and button styling (text, cornerRadius, fontFamily, fontSize, borderWidth, width, height and hex colors background, text, border). Example: {"templateId": "default_calendar_event", "event": {"title": "Tea Time!", "startDatetime": "2030-09-16 15:00:00", "endDatetime": "2030-09-16 16:00:00", "allDay": false}, "button": {"text": "Accept Invite", "cornerRadius": 8}}.
litmus_personalize_conditional_image_previewRender a preview of a Litmus Personalize conditional image while you adjust its settings; nothing is published.Read-onlyPreview Conditional Image
Render a preview of a Litmus Personalize conditional image while you adjust its settings; nothing is published. Returns the preview image URL and click URL. Use litmus_personalize_conditional_image_preview while designing. Use litmus_personalize_conditional_image_publish for the version that goes in the email. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The conditional image settings, sent as data.attributes. Give templateId, parameterName (the URL parameter compared against the rules), rules (each with imageUrl, operator such as equals, does not equal, contains, does not contain, empty, is not empty, is in or is not in, value and clickUrl), fallback (imageUrl and clickUrl) and, for previews, mergeTag (the value to preview). Example: {"templateId": "default_conditional_images", "parameterName": "cheese", "rules": [{"imageUrl": "https://example.com/swiss.png", "operator": "equals", "value": "swiss", "clickUrl": "https://example.com/swiss"}], "fallback": {"imageUrl": "https://example.com/default.png", "clickUrl": "https://example.com/"}}.
litmus_personalize_progress_bar_previewRender a preview of a Litmus Personalize progress bar while you adjust its settings; nothing is published.Read-onlyPreview Progress Bar
Render a preview of a Litmus Personalize progress bar while you adjust its settings; nothing is published. Returns a preview image URL. Use litmus_personalize_progress_bar_preview while designing. Use litmus_personalize_progress_bar_publish for the version that goes in the email. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The progress bar settings, sent as data.attributes. Give templateId, minimumValue and maximumValue (integers), hex colors (background, progressFill, progressBackground, progressValue, minimumValue, maximumValue) and, for previews, preview.progressValue. Example: {"templateId": "linear_progress_bar", "minimumValue": 0, "maximumValue": 100, "colors": {"background": "#FFFFFF", "progressFill": "#40DC59"}, "preview": {"progressValue": 75}}.
litmus_personalize_sentiment_tracker_previewRender a preview of a Litmus Personalize sentiment tracker while you adjust its settings; nothing is published.Read-onlyPreview Sentiment Tracker
Render a preview of a Litmus Personalize sentiment tracker while you adjust its settings; nothing is published. Returns preview image URLs for each option. Use litmus_personalize_sentiment_tracker_preview while designing. Use litmus_personalize_sentiment_tracker_publish for the version that goes in the email. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The sentiment tracker settings, sent as data.attributes. Give templateId, hex colors.resultsValue and, when publishing, url (where voters are redirected). Example: {"templateId": "emoji_sentiment_tracker", "url": "https://example.com/thanks", "colors": {"resultsValue": "#000000"}}.
litmus_personalize_sentiment_tracker_report_getGet the vote results of a published sentiment tracker.Read-onlyGet Sentiment Tracker Report
Get the vote results of a published sentiment tracker. Returns totalClicks and, per option, clickCount and clickPercent. Use litmus_personalize_sentiment_tracker_report_get after sending an email with a tracker from litmus_personalize_sentiment_tracker_publish. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
tracker_idstringrequired- ID of the published sentiment tracker. Example: 3.
litmus_personalize_template_getGet one Litmus Personalize template.Read-onlyGet Personalize Template
Get one Litmus Personalize template. Returns its ID, contentType and supported color attributes. Use litmus_personalize_template_get to see which colors a template accepts. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
template_idstringrequired- Template identifier, from litmus_personalize_templates_list. Example: default_timer.
litmus_personalize_templates_listList Litmus Personalize templates, optionally for one content type.Read-onlyList Personalize Templates
List Litmus Personalize templates, optionally for one content type. Returns each template's ID, contentType and the color attributes it supports. Use litmus_personalize_templates_list to pick a templateId for the preview and publish tools. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
content_typestring- Only templates of this content type, for example timers or sentiment_trackers. Example: timers.
litmus_personalize_timer_previewRender a preview of a Litmus Personalize countdown timer while you adjust its settings; nothing is published.Read-onlyPreview Countdown Timer
Render a preview of a Litmus Personalize countdown timer while you adjust its settings; nothing is published. Returns image URLs for the countdown, expiration and fallback variants. Use litmus_personalize_timer_preview while designing. Use litmus_personalize_timer_publish for the version that goes in the email. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The countdown timer settings, sent as data.attributes. Give templateId, countdown.time (future ISO 8601 UTC target), expiration.message (shown at zero), optional fallback.message (for Apple Mail Privacy Protection), font (Montserrat, Open Sans, Roboto, Lato, Poppins, Noto Sans, Source Serif 4, Lora, PT Serif, Noto Serif or Roboto Slab) and hex colors (background, label_text, digits_text). Example: {"templateId": "default_timer", "countdown": {"time": "2027-02-09T00:00:00Z"}, "expiration": {"message": "The sale has ended."}, "fallback": {"message": "Sale ends on November 20th!"}, "font": "Roboto", "colors": {"background": "#33A8CC", "label_text": "#FFFFFF", "digits_text": "#000000"}}.
litmus_ping_authenticatedCheck that the Litmus v3 API accepts the connection's access token.Read-onlyCheck Litmus Connection
Check that the Litmus v3 API accepts the connection's access token. Returns pong with the token's remaining lifetime and scopes, and the OAuth application's name and UID. Use litmus_ping_authenticated to verify the OAuth connection before other v3 tools. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
This tool takes no inputs.
litmus_spam_seed_addresses_for_test_listList the static and dynamic spam seed addresses for one email test.Read-onlyList Spam Seed Addresses for Test
List the static and dynamic spam seed addresses for one email test. Returns every seed address the email must be sent to for that test's spam results. Use litmus_spam_seed_addresses_for_test_list after litmus_email_test_create when the test includes spam filters. Uses the Basic (API username and password) connection.
Inputs
inbox_guidstringrequired- InboxGuid of the email test, from litmus_email_test_create. Example: 1234567890.
litmus_spam_seed_addresses_listList Litmus's static spam seed addresses.Read-onlyList Spam Seed Addresses
List Litmus's static spam seed addresses. Returns the seed email addresses to include in a send for spam testing. Use litmus_spam_seed_addresses_list when running a spam test with litmus_email_test_create. Use litmus_spam_seed_addresses_for_test_list to also get a test's dynamic seeds. Uses the Basic (API username and password) connection.
Inputs
This tool takes no inputs.
litmus_test_result_getGet one testing application's result within an email test.Read-onlyGet Test Result
Get one testing application's result within an email test. Returns the result's application, state, completion, screenshot URLs, and for spam results the spam score and headers with their ratings. Use litmus_test_result_get for a single client. Use litmus_email_test_get for every result of a test. Uses the Basic (API username and password) connection.
Inputs
result_idintegerrequired- Id of one result, from the Results of litmus_email_test_get. Example: 1.
litmus_testing_applications_listList every email client and spam filter Litmus can test.Read-onlyList Testing Applications
List every email client and spam filter Litmus can test. Returns each application's ApplicationName code, long name, platform, ResultType (0 email preview, 1 spam), average processing time and Status (0 available, 1 slow, 2 unavailable). Use litmus_testing_applications_list to choose ApplicationName values for litmus_email_test_create or litmus_code_analysis_by_applications_create. Uses the Basic (API username and password) connection.
Inputs
This tool takes no inputs.
litmus_accessibility_check_createSubmit an email's HTML for accessibility checks (WCAG and email best practices).WriteRun Accessibility Checks
Submit an email's HTML for accessibility checks (WCAG and email best practices). Returns the email GUID used to fetch the results; the checks run in the background. Use litmus_accessibility_check_create, then poll litmus_accessibility_check_get until meta.state is complete. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
htmlstringrequired- The full HTML of the email to check. Example: <html><body><h1>Spring sale</h1></body></html>.
litmus_analytics_campaign_createCreate an Email Analytics campaign and get its tracking code.WriteCreate Analytics Campaign
Create an Email Analytics campaign and get its tracking code. Returns the campaign GUID and the HTML tracking pixel (bug) to insert into the email before sending. Use litmus_analytics_campaign_create before a send; insert the returned tracking code, then call litmus_analytics_campaign_start. Uses the Basic (API key and passphrase) connection.
Inputs
campaign_namestring- Campaign Name. Example: Spring sale newsletter.
created_viastring- Free-text label for what created the campaign. Example: api.
include_custom_databoolean- Set true to capture custom data passed in the tracking code. Example: true.
is_individualboolean- Set true to record individual (per-recipient) activity. Example: true.
is_privateboolean- Set true to keep the campaign's reports private. Example: true.
track_geolocationboolean- Set true to collect geolocation data for opens. Example: true.
transitional_piiboolean- Set true to handle personal data under transitional PII rules. Example: true.
user_guidstring- Your own GUID for the end user the campaign belongs to. Example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301.
litmus_analytics_campaign_expiration_setSet a new expiration date for a campaign.WriteSet Analytics Campaign Expiration
Set a new expiration date for a campaign. Returns the updated campaign. Use litmus_analytics_campaign_expiration_set to extend or shorten tracking. Use litmus_analytics_campaign_never_expire to remove the expiry. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
expires_atstringrequired- New expiry date and time (ISO 8601, UTC), sent as a JSON string Example: 2027-01-31T00:00:00Z.
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_campaign_export_emailStart an export of a campaign's open data and email the download link.WriteEmail Analytics Campaign Export
Start an export of a campaign's open data and email the download link. Returns the export job. Use litmus_analytics_campaign_export_email to get raw open data as files; the link goes to the given email address. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
emailstring- Address the export download link is sent to. Example: analyst@example.com.
from_datestring- Start of the data range (ISO 8601, UTC). Example: 2026-10-01T00:00:00Z.
split_files_dailyboolean- Set true for one file per day. Example: true.
until_datestring- End of the data range (ISO 8601, UTC). Example: 2026-10-31T00:00:00Z.
litmus_analytics_campaign_never_expireMake a campaign never expire.WriteSet Analytics Campaign to Never Expire
Make a campaign never expire. Returns the updated campaign. Use litmus_analytics_campaign_never_expire for long-running templates or evergreen sends. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_campaign_restartRestart an expired campaign with a new expiration date.WriteRestart Analytics Campaign
Restart an expired campaign with a new expiration date. Returns the restarted campaign. Use litmus_analytics_campaign_restart to resume tracking on an expired campaign. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
new_expiration_datestring- New expiry date and time for the campaign (ISO 8601, UTC). Example: 2027-01-31T00:00:00Z.
litmus_analytics_campaign_startStart tracking opens for a campaign.WriteStart Analytics Campaign
Start tracking opens for a campaign. Returns the started campaign. Use litmus_analytics_campaign_start once the tracking code is in the email and before it is sent. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_campaign_subscribeSubscribe to real-time open notifications for a campaign.WriteSubscribe to Campaign Notifications
Subscribe to real-time open notifications for a campaign. Returns the subscription status. Use litmus_analytics_campaign_subscribe after litmus_analytics_notification_endpoint_configure. Use litmus_analytics_campaign_unsubscribe to stop. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_campaign_unsubscribeStop real-time open notifications for a campaign.WriteUnsubscribe from Campaign Notifications
Stop real-time open notifications for a campaign. Returns the subscription status. Use litmus_analytics_campaign_unsubscribe to stop notifications set up with litmus_analytics_campaign_subscribe. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_analytics_campaign_updateRename a campaign, change its owner GUID, or change when it expires.WriteUpdate Analytics Campaign
Rename a campaign, change its owner GUID, or change when it expires. Returns the updated campaign. Use litmus_analytics_campaign_update for name or expiry changes. Use litmus_analytics_campaign_never_expire to remove the expiry. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
campaign_namestring- Campaign Name. Example: Spring sale newsletter.
expires_atstring- New expiry date and time (ISO 8601, UTC). Example: 2027-01-31T00:00:00Z.
never_expiresboolean- Set true so the campaign never expires. Example: true.
user_guidstring- Your own GUID for the end user the campaign belongs to. Example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301.
litmus_analytics_notification_endpoint_configureSet the HTTPS URL that receives real-time open notifications for a user's subscribed campaigns.WriteConfigure Analytics Notification Endpoint
Set the HTTPS URL that receives real-time open notifications for a user's subscribed campaigns. Returns the saved configuration. Use litmus_analytics_notification_endpoint_configure first, then litmus_analytics_campaign_subscribe for each campaign. Uses the Basic (API key and passphrase) connection.
Inputs
endpointstring- HTTPS URL that will receive notification POSTs. Example: https://example.com/litmus-callback.
user_guidstring- Your own GUID for the end user the campaign belongs to. Example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301.
litmus_code_analysis_by_applications_createAnalyze an email's HTML and CSS for problems in chosen email clients only.WriteRun Code Analysis for Clients
Analyze an email's HTML and CSS for problems in chosen email clients only. Returns the same compatibility and HTML problems as litmus_code_analysis_create, limited to those clients. Use litmus_code_analysis_by_applications_create when you only support some clients; get codes from litmus_testing_applications_list. Uses the Basic (API username and password) connection.
Inputs
htmlstringrequired- The HTML part of the email only (no subject line or plain-text part). Example: <h1>Test</h1><p><a href="https://www.litmus.com">Litmus</a></p>.
testing_applicationsarray- ApplicationName codes of the clients to check, from litmus_testing_applications_list. Example: ["ol2010", "gmailnew"].
litmus_code_analysis_createAnalyze an email's HTML and CSS for compatibility and syntax problems across email clients.WriteRun Code Analysis
Analyze an email's HTML and CSS for compatibility and syntax problems across email clients. Returns CompatibilityProblems and HtmlProblems with line numbers, severity and descriptions, and the number of rules checked. Use litmus_code_analysis_create for all clients. Use litmus_code_analysis_by_applications_create to limit it to some clients. Uses the Basic (API username and password) connection.
Inputs
htmlstringrequired- The HTML part of the email only (no subject line or plain-text part), sent as a JSON string Example: <div><a href='https://www.litmus.com?utm_source=twitter'>Litmus</a></div>.
litmus_email_test_createCreate an email preview (and optional spam) test for some or all Litmus email clients; it uses Litmus test credits.WriteCreate Email Preview Test
Create an email preview (and optional spam) test for some or all Litmus email clients; it uses Litmus test credits. Returns the test Id, its InboxGuid and one pending result per testing application. Use litmus_email_test_create to start previews: then send the email to <InboxGuid>@emailtests.com (it must be in To, CC or BCC) and poll litmus_email_test_get. For a spam test, also send to the addresses from litmus_spam_seed_addresses_list. Uses the Basic (API username and password) connection.
Inputs
testing_applicationsarray- Email clients (and spam filters) to test, each by ApplicationName from litmus_testing_applications_list. Leave empty to test every application. Example: [{"ApplicationName": "OL2010"}, {"ApplicationName": "GMAILNEW"}].
user_guidstring- Your own GUID for the end user this test is for. Needed when you offer unlimited testing to your users, so Litmus can count unique users. Example: 3f2504e0-4f89-11d3-9a0c-0305e82c3301.
litmus_guardian_email_enrollEnroll an email in Email Guardian, which keeps monitoring its rendering, links and images for changes.WriteEnroll Email in Email Guardian
Enroll an email in Email Guardian, which keeps monitoring its rendering, links and images for changes. Returns the enrolled email's ID. Use litmus_guardian_email_enroll for emails that keep being sent (welcome, transactional). Read changes with litmus_guardian_email_result_get or a webhook from litmus_guardian_webhook_create. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
htmlstringrequired- The full HTML of the email to monitor. Example: <html><body><h1>Spring sale</h1></body></html>.
integration_user_idstringrequired- ID of the integration user (your end user) you act for, from litmus_integration_user_create. Example: 1.
litmus_guardian_webhook_createRegister a webhook that Email Guardian POSTs to when it detects a major rendering or link change.WriteRegister Email Guardian Webhook
Register a webhook that Email Guardian POSTs to when it detects a major rendering or link change. Returns the webhook's ID and URL. Use litmus_guardian_webhook_create once, then check it with litmus_guardian_webhook_test. Unregistering is not available in the API yet. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
urlstringrequired- HTTPS URL that will receive JSON:API change notifications. Example: https://example.com/litmus-webhook.
litmus_guardian_webhook_testAsk Litmus to send a sample notification to a registered webhook.WriteSend Email Guardian Test Notification
Ask Litmus to send a sample notification to a registered webhook. Returns 204 No Content; the sample arrives at your webhook. Use litmus_guardian_webhook_test after litmus_guardian_webhook_create to check your endpoint handles link_change and client_change documents. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
change_typestringrequired- Which sample to send: link_change or client_change. Example: link_change.one of
link_changeclient_change webhook_idstringrequired- ID of the webhook, from litmus_guardian_webhook_create. Example: 7.
litmus_integration_user_createCreate an anonymous integration user that represents one of your end users in Litmus.WriteCreate Integration User
Create an anonymous integration user that represents one of your end users in Litmus. Returns the integration user's ID. Use litmus_integration_user_create once per end user, then pass its ID to litmus_guardian_email_enroll. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
This tool takes no inputs.
litmus_link_test_createCheck every link in an email's HTML.WriteCreate Link Check Test
Check every link in an email's HTML. Returns the LinkTest Id and State; links are checked in the background. Use litmus_link_test_create before sending, then poll litmus_link_test_get until State is Complete. Uses the Basic (API username and password) connection.
Inputs
htmlstringrequired- The HTML part of the email only (no subject line or plain-text part), sent as a JSON string Example: <div><a href='https://www.litmus.com?utm_source=twitter'>Litmus</a></div>.
litmus_personalize_calendar_event_publishPublish a Litmus Personalize calendar event for use in a live email.WritePublish Calendar Event
Publish a Litmus Personalize calendar event for use in a live email. Returns a button image URL and add-to-calendar links (ics, Google, Outlook, Apple, AOL, Yahoo). Use litmus_personalize_calendar_event_publish when the design is final; the request body is the same as litmus_personalize_calendar_event_preview. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The calendar event settings, sent as data.attributes. Give templateId, event (title, startDatetime, endDatetime unless allDay, description, location, allDay) and button styling (text, cornerRadius, fontFamily, fontSize, borderWidth, width, height and hex colors background, text, border). Example: {"templateId": "default_calendar_event", "event": {"title": "Tea Time!", "startDatetime": "2030-09-16 15:00:00", "endDatetime": "2030-09-16 16:00:00", "allDay": false}, "button": {"text": "Accept Invite", "cornerRadius": 8}}.
litmus_personalize_conditional_image_publishPublish a Litmus Personalize conditional image for use in a live email.WritePublish Conditional Image
Publish a Litmus Personalize conditional image for use in a live email. Returns an image URL and click URL that take the parameter value as a merge tag. Use litmus_personalize_conditional_image_publish when the design is final; the request body is the same as litmus_personalize_conditional_image_preview. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The conditional image settings, sent as data.attributes. Give templateId, parameterName (the URL parameter compared against the rules), rules (each with imageUrl, operator such as equals, does not equal, contains, does not contain, empty, is not empty, is in or is not in, value and clickUrl), fallback (imageUrl and clickUrl) and, for previews, mergeTag (the value to preview). Example: {"templateId": "default_conditional_images", "parameterName": "cheese", "rules": [{"imageUrl": "https://example.com/swiss.png", "operator": "equals", "value": "swiss", "clickUrl": "https://example.com/swiss"}], "fallback": {"imageUrl": "https://example.com/default.png", "clickUrl": "https://example.com/"}}.
litmus_personalize_progress_bar_publishPublish a Litmus Personalize progress bar for use in a live email.WritePublish Progress Bar
Publish a Litmus Personalize progress bar for use in a live email. Returns the progress bar image URL, whose value is set per recipient with a merge tag. Use litmus_personalize_progress_bar_publish when the design is final; the request body is the same as litmus_personalize_progress_bar_preview. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The progress bar settings, sent as data.attributes. Give templateId, minimumValue and maximumValue (integers), hex colors (background, progressFill, progressBackground, progressValue, minimumValue, maximumValue) and, for previews, preview.progressValue. Example: {"templateId": "linear_progress_bar", "minimumValue": 0, "maximumValue": 100, "colors": {"background": "#FFFFFF", "progressFill": "#40DC59"}, "preview": {"progressValue": 75}}.
litmus_personalize_sentiment_tracker_publishPublish a Litmus Personalize sentiment tracker for use in a live email.WritePublish Sentiment Tracker
Publish a Litmus Personalize sentiment tracker for use in a live email. Returns an image URL and a vote URL for each option; read votes with litmus_personalize_sentiment_tracker_report_get. Use litmus_personalize_sentiment_tracker_publish when the design is final; the request body is the same as litmus_personalize_sentiment_tracker_preview. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The sentiment tracker settings, sent as data.attributes. Give templateId, hex colors.resultsValue and, when publishing, url (where voters are redirected). Example: {"templateId": "emoji_sentiment_tracker", "url": "https://example.com/thanks", "colors": {"resultsValue": "#000000"}}.
litmus_personalize_timer_publishPublish a Litmus Personalize countdown timer for use in a live email.WritePublish Countdown Timer
Publish a Litmus Personalize countdown timer for use in a live email. Returns the animated timer GIF URL (its exp query parameter can be overridden with a merge tag). Use litmus_personalize_timer_publish when the design is final; the request body is the same as litmus_personalize_timer_preview. Uses the OAuth connection (Litmus v3 API, early access).
Inputs
attributesobjectrequired- The countdown timer settings, sent as data.attributes. Give templateId, countdown.time (future ISO 8601 UTC target), expiration.message (shown at zero), optional fallback.message (for Apple Mail Privacy Protection), font (Montserrat, Open Sans, Roboto, Lato, Poppins, Noto Sans, Source Serif 4, Lora, PT Serif, Noto Serif or Roboto Slab) and hex colors (background, label_text, digits_text). Example: {"templateId": "default_timer", "countdown": {"time": "2027-02-09T00:00:00Z"}, "expiration": {"message": "The sale has ended."}, "fallback": {"message": "Sale ends on November 20th!"}, "font": "Roboto", "colors": {"background": "#33A8CC", "label_text": "#FFFFFF", "digits_text": "#000000"}}.
litmus_analytics_campaign_clearDelete all collected data of a campaign.DestructiveClear Analytics Campaign Data
Delete all collected data of a campaign. This cannot be undone. Returns the cleared campaign. Use litmus_analytics_campaign_clear only to wipe test opens or data you must remove. Uses the Basic (API key and passphrase) connection.
- Idempotent
Inputs
guidstringrequired- GUID of the Email Analytics campaign, from litmus_analytics_campaign_create. Example: 8bd5a2c0-1f3e-4b7a-9d6c-2e4f6a8b0c1d.
litmus_email_test_files_deleteDelete the files (screenshots and source) of an email preview test; the test record itself is kept.DestructiveDelete Email Preview Test Files
Delete the files (screenshots and source) of an email preview test; the test record itself is kept. Returns an empty response on success. Use litmus_email_test_files_delete to remove captured images of a test that is no longer needed. Uses the Basic (API username and password) connection.
- Idempotent
Inputs
test_idintegerrequired- Id of the email test, from litmus_email_test_create. Example: 1.
litmus_guardian_email_unenrollStop monitoring an email in Email Guardian.DestructiveUnenroll Email from Email Guardian
Stop monitoring an email in Email Guardian. Returns 204 No Content on success. Use litmus_guardian_email_unenroll when an email is retired. Use litmus_guardian_emails_list to find email IDs. Uses the OAuth connection (Litmus v3 API, early access).
- Idempotent
Inputs
email_idstringrequired- ID of the enrolled Email Guardian email, from litmus_guardian_email_enroll or litmus_guardian_emails_list. Example: 11.
integration_user_idstringrequired- ID of the integration user (your end user) you act for, from litmus_integration_user_create. Example: 1.
No tools match.