Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Contacts, segments and issues on MailCheap, cloud or your own server. Mira adds signups and drafts issues for you to approve.
| Field | What it is |
|---|---|
| Server address | Leave blank for MailCheap Cloud, or enter your own MailCheap address |
| API key | API keys page, Full access |
| Newsletter for Site signups | Its id or slug. Leave blank for your first newsletter |
| Tool | What it does |
|---|---|
list_newsletters | The account’s newsletters, with their settings and active contacts |
get_overview | One newsletter’s subscriber growth and email results over a period |
add_subscriber | Sign someone up. They get the newsletter’s welcome or confirmation email. |
list_contacts | Contacts, newest first, 50 a page |
list_tags | Tags, most used first |
tag_contacts | Add tags to contacts, keeping the tags they have |
list_segments | Segments, with how many active contacts each picks |
list_campaigns | Issues, newest activity first, without their content |
get_campaign | One issue: its content, its stats and, for a draft, what would block sending it |
get_campaign_tips | What in a draft’s words tends to land email in spam |
create_campaign | Save a new issue as a draft. It is never sent from here. |
update_campaign | Change a draft |
send_test_email | Send a draft to the owner’s own test addresses, never to the list |
send_campaign | Send an issue to the list now |
schedule_campaign | Schedule an issue. It goes out by itself at that time. |
send_campaign_to_more | Send a sent issue to contacts who haven’t had it yet |
unschedule_campaign | Turn a scheduled issue back into a draft |
pause_campaign | Stop an issue that is sending. The rest wait until the owner resumes it. |
get_campaign_report | Delivery, open, click, bounce and unsubscribe rates of a sent issue, against earlier issues |
Was this page helpful?
