Send a transactional email from a verified MisarMail account. `from.email` must match an email account you have already verified — use list_domains to check which sender domains are available. Returns the message ID and queue status.
輸入參數ccto必填bccfrom必填htmltagstextsubject必填alias_idmetadatareply_toidempotency_key
List emails from a mailbox folder with optional full-text search across subject and body. Use this for reading the unified inbox; use list_campaigns for marketing sends.
輸入參數limitfoldersearch
Read the full content of a single email by ID, including headers, body, and attachments metadata. Side effect: marks the email as read.
輸入參數id必填
reply_to_email
Reply to email
Reply to an existing email thread. The sender address and threading headers are derived from the original message, so only the body is required.
輸入參數htmltextemail_id必填
archive_email
Archive email
Move an email to the archive folder. Reversible — the message is not deleted.
輸入參數id必填
validate_email
Validate address
Validate an email address before sending: syntax, MX records, disposable-domain and role-account detection. Use this to protect sender reputation on imported lists.
輸入參數email必填
list_campaigns
List campaigns
List email marketing campaigns with their status, audience size, and headline metrics. Filter by status to find drafts ready to send or campaigns still sending.
輸入參數pagelimitstatus
Get full details for one campaign: content, audience segment, schedule, and delivery statistics (sent, opened, clicked, bounced, complained).
輸入參數campaign_id必填
create_campaign
Create campaign
Create a new email marketing campaign as a draft. Creating never sends or schedules anything — once the content and audience are confirmed, call send_campaign to send it now or schedule it for later.
輸入參數htmlname必填textsubject必填reply_tofrom_name必填from_email必填segment_idtemplate_id
send_campaign
Send campaign
Send a campaign now, or schedule it for a future time by passing scheduled_at. This delivers real email to real recipients and cannot be undone once sending starts — confirm the audience with get_campaign first.
輸入參數campaign_id必填scheduled_at
list_contacts
List contacts
List contacts with their subscription status and engagement metrics. Filter by status to find unsubscribed or bounced addresses that should be excluded from sends.
輸入參數pagelimitsearchstatus
create_contact
Create contact
Add a single contact. Adding a contact records consent to email them — only add addresses that opted in, or the send will damage sender reputation and may breach CAN-SPAM/GDPR.
輸入參數tagsemail必填sourcelast_namefirst_namecustom_fields
update_contact
Update contact
Update an existing contact by email address, including changing subscription status. Setting status to unsubscribed immediately excludes them from every future campaign. Does not support tags, phone, company, or job title — the API has no fields for them.
輸入參數email必填statuslast_namefirst_namecustom_fields
import_contacts
Import contacts
Bulk-import up to 5,000 contacts in one call. By default, addresses that already exist are skipped rather than duplicated — pass update_existing: true to update them instead. Returns per-row results so you can see which rows were rejected and why.
輸入參數contacts必填update_existing
get_contact_score
Contact engagement score
Get engagement score, engagement tier, and churn risk for one contact — or the lowest-engagement contacts across the list when contact_id is omitted. Use before a re-engagement campaign.
輸入參數contact_id
list_templates
List templates
List saved email templates with their variable placeholders, so you can pick one for a campaign or transactional send.
輸入參數pagetypelimit
create_template
Create template
Create a reusable email template. Use {{variable}} placeholders for personalisation — they are substituted at send time and previewable via render_template.
輸入參數html必填name必填texttypesubject必填variables
render_template
Render template
Render a template with sample variables and return the resulting HTML and subject. Use this to preview personalisation before sending anything.
輸入參數variablestemplate_id必填
list_automations
List automations
List automation workflows (welcome series, re-engagement, drip sequences) with their trigger type and active state.
輸入參數pagelimitstatus
get_automation
Get automation
Get one automation workflow in full: trigger, every step with its delay, and per-step completion stats.
輸入參數automation_id必填
create_automation
Create automation
Create an automation workflow from a trigger, saved as a paused draft. The API's create endpoint only accepts a name and trigger — it has no fields for workflow steps or starting active; configure the step sequence in the MisarMail dashboard's visual builder, and use toggle_automation to activate once reviewed.
輸入參數name必填trigger必填trigger_config
toggle_automation
Toggle automation
Activate or pause an automation. Activating starts enrolling contacts and sending on the configured schedule.
輸入參數active必填automation_id必填
list_ab_tests
List A/B tests
List A/B tests with per-variant results and whether a winner has been selected yet.
輸入參數pagetypelimit
create_ab_test
Create A/B test
Create one A/B test variant on a campaign. The real API stores a single variant per call, so build a test by calling this once per variant (e.g. twice for a plain A/B split) using the same campaign_id and distinct `variant` labels. Each variant gets send_percent of the audience; auto_select_winner (with winner_wait_hours) can pick and send the winner automatically, or use select_ab_test_winner to do it manually.
輸入參數subjectvariant必填body_htmlfrom_namepreheadertest_typecampaign_id必填send_time_asend_time_bsend_percentwinner_wait_hoursauto_select_winner
select_ab_test_winner
Select A/B winner
Select the winning variant and send it to the remaining audience. This triggers a real send to everyone who was held back — it cannot be undone.
輸入參數metrictest_id必填winner_variant必填
get_analytics
Get analytics
Get delivery and engagement analytics — sent, delivered, opened, clicked, bounced, and complained — for the account or one campaign, grouped by day/week/month.
輸入參數periodend_dategroup_bystart_datecampaign_id
get_analytics_timeline
Get analytics timeline
Get a day/week/month breakdown of sent, delivered, opened, clicked, bounced, complained, replied, and unsubscribed — across every send medium (campaigns, inbox compose, API, MCP, SDKs, GraphQL, automations). The timeline counterpart to get_analytics's period totals.
輸入參數periodend_dategroup_bystart_date
generate_report
Generate report
Generate a structured analytics report over a date range. Report types: campaign_performance, engagement_funnel, cohort_analysis, and send_time_heatmap (best hour/day to send).
輸入參數date_todate_fromreport_type必填
get_revenue_attribution
Revenue attribution
Attribute ecommerce revenue to email — revenue per campaign, per contact, and average order value from tracked conversions.
輸入參數periodcampaign_id
get_monetization_stats
Monetization stats
Get newsletter monetization stats: paid subscribers, MRR, churn, and sponsorship revenue for the period.
輸入參數period
get_deliverability_score
Deliverability score
Get the account deliverability score (0–100) and letter grade (A–F) with the factors dragging it down. Start here when asked why emails are landing in spam.
無需輸入參數。
run_deliverability_audit
Deliverability audit
Run a full deliverability audit across authentication (SPF/DKIM/DMARC), domain reputation, list hygiene, content signals, and blocklist status. Returns prioritized findings.
無需輸入參數。
get_warmup_status
Warm-up status
Get IP/domain warm-up progress and today's remaining send capacity. Exceeding warm-up capacity on a new domain is the fastest way to get throttled or blocklisted.
無需輸入參數。
check_dmarc
Check DMARC/SPF/DKIM
Check live SPF, DKIM, and DMARC DNS records for a domain and report alignment problems with the exact record to publish. Works for any domain, not only your own.
輸入參數domain必填
List sending domains with verification status and their DKIM/SPF/DMARC records. Check here first when a send fails with an unverified-sender error.
輸入參數pagelimit
Add a sending domain and return the DNS records to publish. The domain cannot send until those records are live and verify_domain succeeds.
輸入參數domain必填
verify_domain
Verify domain
Re-check a domain's DNS records and mark it verified if they resolve. Safe to retry — DNS propagation can take up to 48 hours.
輸入參數domain_id必填
configure_inbound_domain
Configure inbound
Configure inbound email routing for a subdomain so replies land in the MisarMail unified inbox. Returns the MX record to publish.
輸入參數domain必填subdomain必填webhook_url必填
List signup forms with their embed status and conversion counts.
輸入參數pagelimitstatus
Get one signup form including its fields, embed code, and redirect behaviour.
輸入參數form_id必填
get_form_submissions
Form submissions
List submissions for a signup form, including the submitted field values and timestamps.
輸入參數pagelimitform_id必填
create_landing_page
Create landing page
Create a hosted landing page with a single hero block (headline, subheadline, CTA). Returns the public URL. The real API stores pages as a page-builder block array with no dedicated headline/CTA fields, so this tool translates your inputs into one 'hero' block — for multi-block pages or a real CTA link, use the landing page editor in the MisarMail dashboard.
輸入參數name必填slugcta_textheadline必填subheadline
list_marketplace_items
Browse marketplace
Browse the MisarMail template marketplace for ready-made email and automation templates.
輸入參數pagelimitsearchcategory
get_marketplace_item
Get marketplace item
Get one marketplace listing with its full preview, author, and install count.
輸入參數item_id必填
list_inbox_conversations
List conversations
List unified-inbox conversations (threads) with their status and detected intent. Use this for triage; use list_emails for individual messages in a folder.
輸入參數qlimitintentoffsetstatuschannel
get_inbox_conversation_messages
Conversation messages
Get every message in one inbox conversation, oldest first, with sender and timestamps.
輸入參數conversation_id必填
categorize_inbox_emails
Categorize inbox
Run AI categorisation over a batch of inbox emails to label intent and priority. Consumes AI credits — pass only the emails you actually need triaged.
輸入參數email_ids必填
list_api_keys
List API keys
List API keys on the account with their scopes and last-used time. Key secrets are never returned — only metadata.
無需輸入參數。
generate_subject_lines
Generate subject lines
Generate AI subject-line variants for a campaign topic, optionally tuned to a tone and audience. Good input for create_ab_test.
輸入參數tonecounttopic必填audience
list_integrations
List integrations
List connected third-party integrations and their sync status.
輸入參數pagelimit
get_integration
Get integration
Get one integration's configuration, scopes, and last sync result.
輸入參數integration_id必填
toggle_integration
Toggle integration
Enable or disable an integration. Disabling stops all syncing but preserves the stored credentials.
輸入參數enabled必填integration_id必填
list_sandbox_sends
List sandbox sends
List emails captured by sandbox mode. Sandbox intercepts sends instead of delivering them — use it to verify templates and automations without emailing anyone.
無需輸入參數。
clear_sandbox
Clear sandbox
Delete every captured sandbox email. Affects only intercepted test messages, never real sent mail.
無需輸入參數。
upgrade
Plan usage and upgrade
Show the current MisarMail plan, how much of each quota is left, and what upgrading unlocks, with the link to upgrade. Call it any time — not only after hitting a limit. Reads only: it never changes the plan or takes payment; the user upgrades by following the link. On a local install, open=true also opens that link in the user's browser.
輸入參數openplan