# Mailsoftly: Email Marketing & Automation API > Mailsoftly is an email marketing and automation platform for growing businesses. Build integrations, manage contacts, send campaigns, read reports and automate workflows through a REST API or the hosted MCP server. ## Quick Links - Website: https://mailsoftly.com - API Documentation: https://app.mailsoftly.com/developers - MCP Server Documentation: https://app.mailsoftly.com/developers/mcp - OpenAPI Spec: https://app.mailsoftly.com/developers/openapi.json - MCP tool summary: https://app.mailsoftly.com/developers/tools.json - Full reference in one file (every endpoint with parameters, request bodies, examples and scopes): https://app.mailsoftly.com/llms-full.txt - AI Plugin Manifest: https://app.mailsoftly.com/.well-known/ai-plugin.json ## API Overview - Base URL: `https://app.mailsoftly.com/api/v3/` - Auth: API key in the `Authorization` header (raw token, no Bearer prefix) or an OAuth 2.1 bearer token - Format: JSON - Rate Limit: 300 requests per 5 minutes per IP - Scopes: contacts:read, contacts:write, campaigns:read, campaigns:draft, campaigns:send, sms:send, suppressions:write, account:read, account:write (each operation declares its scope as x-scope in the OpenAPI spec) ## MCP - Hosted server: `https://app.mailsoftly.com/mcp` (Streamable HTTP, OAuth; sending is a separate opt-in on the consent screen). 134 curated tools, one per live endpoint carrying an x-mcp-tool annotation. Transactional email is REST only (API key or OAuth with campaigns:send), not a hosted MCP tool. - Local server: the open source `mcp-server` package builds one tool per live endpoint from the OpenAPI spec with your API key. ## Live Endpoints (150) ### Authentication - `POST /api/v3/authentication`: Verify API credentials ### Contacts - `GET /api/v3/get_contacts`: List all contacts - `GET /api/v3/get_contact?contact_id=...`: Get a single contact - `GET /api/v3/get_contact_fields`: List available contact fields - `POST /api/v3/create_contact`: Create a new contact - `POST /api/v3/update_contact`: Update an existing contact - `POST /api/v3/create_or_update_contact`: Create or update a contact - `GET /api/v3/search_contacts`: Search contacts - `POST /api/v3/delete_contact`: Delete a contact - `POST /api/v3/remove_tags_from_contact`: Remove tags from a contact - `GET /api/v3/get_contact_activity?contact_id=...`: Get one contact's activity timeline - `POST /api/v3/add_contact_note`: Write a note on a contact - `POST /api/v3/import_contacts`: Import contacts from a CSV - `GET /api/v3/get_import?id=...`: Get one import and its progress - `GET /api/v3/list_imports`: List contact imports - `GET /api/v3/get_contact_subscriptions?contact_id=...`: Get what one contact is subscribed to - `POST /api/v3/update_contact_subscriptions`: Change what one contact is subscribed to ### Contact Lists - `GET /api/v3/get_contact_lists`: List all contact lists - `GET /api/v3/get_contact_list?contact_list_id=...`: Get a single contact list - `GET /api/v3/get_contact_list_contacts?contact_list_id=...`: List contacts in a contact list - `POST /api/v3/create_contact_list`: Create a new contact list - `POST /api/v3/add_contact_to_contact_list`: Add a single contact to a list - `POST /api/v3/add_contacts_to_contact_list`: Add multiple contacts to a list - `POST /api/v3/remove_contact_from_contact_list`: Remove a contact from a list - `POST /api/v3/update_contact_list`: Rename a contact list - `POST /api/v3/delete_contact_list`: Delete a contact list ### Tags - `GET /api/v3/get_tags`: List all tags - `POST /api/v3/assign_tag_to_contact`: Assign a tag to a contact - `POST /api/v3/assign_tags_to_contact`: Assign multiple tags to a contact - `POST /api/v3/create_tag`: Create a tag - `POST /api/v3/update_tag`: Rename or recolor a tag - `POST /api/v3/delete_tag`: Delete a tag ### Custom Fields - `GET /api/v3/get_custom_fields`: List all custom fields - `POST /api/v3/add_custom_field_to_contact`: Add a custom field to a contact - `POST /api/v3/create_custom_field`: Define a custom contact field ### Emails - `POST /api/v3/create_emails`: Create email drafts - `GET /api/v3/email_status?id=...`: Check email draft status - `POST /api/v3/send_email`: Send an email draft - `POST /api/v3/send_transactional_email`: Send a transactional email - `POST /api/v3/send_transactional_sms`: Send a transactional SMS - `GET /api/v3/get_message_status`: Get a transactional email's status - `GET /api/v3/get_status_webhook`: Get the status webhook - `POST /api/v3/set_status_webhook`: Create or update the status webhook - `POST /api/v3/delete_status_webhook`: Remove the status webhook - `POST /api/v3/test_status_webhook`: Send a test event to the status webhook ### Unsubscribes - `POST /api/v3/add_global_email_unsubscriber`: Globally unsubscribe an email - `POST /api/v3/remove_global_email_unsubscriber`: Resubscribe an email ### Email Templates - `GET /api/v3/get_email_templates`: List email templates - `GET /api/v3/get_email_template?id=...`: Get a single email template - `POST /api/v3/create_email_template`: Create an email template - `POST /api/v3/update_email_template`: Update an email template - `POST /api/v3/delete_email_template`: Delete an email template ### Email Senders - `GET /api/v3/list_senders`: List available senders - `GET /api/v3/get_email_senders`: List verified email senders ### Automations - `GET /api/v3/get_automations`: List automations - `GET /api/v3/get_automation?id=...`: Get a single automation - `GET /api/v3/get_automation_stats?id=...`: Get automation performance - `POST /api/v3/trigger_automation`: Trigger an automation for a contact - `POST /api/v3/report_contact_reply`: Report that a contact replied - `POST /api/v3/create_automation`: Create an automation - `POST /api/v3/update_automation_status`: Activate or deactivate an automation - `POST /api/v3/delete_automation`: Delete an automation - `POST /api/v3/update_automation`: Update an automation - `POST /api/v3/update_automation_step`: Update one automation step ### Forms - `GET /api/v3/get_forms`: List forms - `GET /api/v3/get_form?id=...`: Get a single form - `GET /api/v3/get_form_responses?form_id=...`: List form submissions - `POST /api/v3/create_form`: Create a signup or lead form - `POST /api/v3/update_form`: Update a form - `POST /api/v3/delete_form`: Delete a form ### Landing Pages - `GET /api/v3/get_pages`: List landing pages - `GET /api/v3/get_page?id=...`: Get a single landing page - `POST /api/v3/create_landing_page`: Create a landing page - `POST /api/v3/update_landing_page`: Update a landing page - `POST /api/v3/publish_landing_page`: Publish or unpublish a landing page - `POST /api/v3/trash_landing_page`: Move a landing page to the trash ### Segments - `GET /api/v3/get_segments`: List saved segments - `POST /api/v3/create_segment`: Create a segment - `POST /api/v3/update_segment`: Update a segment - `POST /api/v3/delete_segment`: Delete a segment - `POST /api/v3/refresh_segment`: Recalculate a segment ### Integrations - `GET /api/v3/get_integrations`: List active integrations - `GET /api/v3/get_endpoints`: List webhook endpoints ### Signatures - `GET /api/v3/get_signatures`: List email signatures - `POST /api/v3/create_signature`: Create an email signature - `POST /api/v3/update_signature`: Update an email signature - `POST /api/v3/delete_signature`: Delete an email signature ### Suppressions - `GET /api/v3/get_suppressions`: List suppressed emails - `POST /api/v3/add_suppression`: Add an address to the suppression list ### Account - `GET /api/v3/get_account`: Get account info - `GET /api/v3/get_team_members`: List team members - `POST /api/v3/invite_team_member`: Invite a teammate - `GET /api/v3/list_pending_invitations`: List pending invitations - `POST /api/v3/revoke_invitation`: Revoke a pending invitation - `POST /api/v3/update_team_member_role`: Change a teammate's role - `GET /api/v3/list_api_keys`: List the account's API keys - `GET /api/v3/list_connected_apps`: List connected apps - `GET /api/v3/list_audit_events`: List the account's audit trail ### Campaigns - `POST /api/v3/publish_canva_email`: Publish a Canva email design as a campaign draft - `GET /api/v3/get_canva_connection`: Name the account connected to Canva - `POST /api/v3/update_email`: Update a campaign draft - `GET /api/v3/list_campaigns`: List campaigns - `GET /api/v3/get_campaign_stats?id=...`: Get campaign performance - `POST /api/v3/schedule_email`: Schedule a campaign - `POST /api/v3/trash_campaign`: Move a campaign to the trash - `POST /api/v3/delete_campaign`: Delete an unsent campaign permanently - `POST /api/v3/restore_campaign`: Restore a campaign from the trash - `POST /api/v3/start_ab_test`: Start an A/B subject test - `POST /api/v3/unschedule_email`: Cancel a scheduled send - `GET /api/v3/get_campaign_report?id=...`: Get a full campaign report - `GET /api/v3/get_campaign_links?id=...`: Get per link clicks for a campaign - `GET /api/v3/get_campaign_recipients?id=...`: List the recipients of a campaign - `GET /api/v3/preview_campaign_audience?id=...`: Preview who a campaign would go to - `GET /api/v3/get_campaign?id=...`: Get one campaign in full - `POST /api/v3/send_test_email`: Send a test copy of a campaign - `POST /api/v3/duplicate_campaign`: Copy a campaign into a new draft - `POST /api/v3/update_campaign_sharing`: Change how a campaign is shared on the web - `POST /api/v3/add_campaign_attachment`: Attach a file to a draft campaign - `POST /api/v3/remove_campaign_attachment`: Remove a file from a draft campaign ### Compliance - `GET /api/v3/get_compliance_summary`: Get the compliance summary for a region - `GET /api/v3/get_consent_evidence`: List consent evidence - `GET /api/v3/get_opt_outs`: List opt-out records - `POST /api/v3/record_consent`: Record a consent - `GET /api/v3/get_iys_summary`: Get the registry filing status ### Media - `GET /api/v3/list_files`: List hosted files - `POST /api/v3/upload_file`: Upload a file to the gallery - `POST /api/v3/delete_file`: Remove a file from the gallery - `GET /api/v3/list_images`: List the image library - `POST /api/v3/upload_image`: Upload an image ### Content Blocks - `GET /api/v3/list_custom_blocks`: List saved content blocks - `GET /api/v3/get_custom_block?custom_block_id=...`: Get one content block - `POST /api/v3/create_custom_block`: Save a content block - `POST /api/v3/update_custom_block`: Update a content block - `POST /api/v3/delete_custom_block`: Delete a content block ### Brand Kit - `GET /api/v3/get_brand_kit`: Get the brand kit - `POST /api/v3/update_brand_kit`: Update the brand kit ### Domain Health - `GET /api/v3/list_domain_health_checks`: List saved domain health checks - `POST /api/v3/run_domain_health_check`: Run a domain health check ### Email Types - `GET /api/v3/get_email_types`: List email types - `POST /api/v3/create_email_type`: Create an email type ### Sending Identity - `GET /api/v3/list_domains`: List sending domains - `POST /api/v3/add_domain`: Add a sending domain - `POST /api/v3/verify_domain`: Check a domain's DNS records - `POST /api/v3/remove_domain`: Archive a sending domain - `POST /api/v3/create_sender`: Create a sender address - `POST /api/v3/delete_sender`: Remove a sender address - `GET /api/v3/list_reply_to_addresses`: List reply-to addresses - `POST /api/v3/create_reply_to_address`: Add a reply-to address ### Webhooks - `POST /api/v3/create_endpoint`: Create a webhook endpoint - `POST /api/v3/delete_endpoint`: Delete a webhook endpoint ## Not in the API WhatsApp, SMS messages, Shopify objects, billing, contact export, API key creation and revocation. Manage those in the app.