API Endpoints

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_api_keys - List the account's API keys
GET /api/v3/list_audit_events - List the account's audit trail
GET /api/v3/list_connected_apps - List connected apps
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
POST /api/v3/authentication - Verify API credentials
POST /api/v3/create_automation - Create an automation
POST /api/v3/delete_automation - Delete an automation
GET /api/v3/get_automation - Get a single automation
GET /api/v3/get_automations - List automations
POST /api/v3/trigger_automation - Trigger an automation for a contact
POST /api/v3/update_automation - Update an automation
POST /api/v3/update_automation_status - Activate or deactivate an automation
GET /api/v3/get_brand_kit - Get the brand kit
POST /api/v3/update_brand_kit - Update the brand kit
POST /api/v3/add_campaign_attachment - Attach a file to a draft campaign
POST /api/v3/duplicate_campaign - Copy a campaign into a new draft
GET /api/v3/get_campaign - Get one campaign in full
GET /api/v3/get_campaign_links - Get per link clicks for a campaign
GET /api/v3/get_campaign_recipients - List the recipients of a campaign
GET /api/v3/get_campaign_report - Get a full campaign report
GET /api/v3/get_campaign_stats - Get campaign performance
GET /api/v3/list_campaigns - List campaigns
GET /api/v3/preview_campaign_audience - Preview who a campaign would go to
POST /api/v3/remove_campaign_attachment - Remove a file from a draft campaign
POST /api/v3/restore_campaign - Restore a campaign from the trash
POST /api/v3/schedule_email - Schedule a campaign
POST /api/v3/send_test_email - Send a test copy of a campaign
POST /api/v3/start_ab_test - Start an A/B subject test
POST /api/v3/trash_campaign - Move a campaign to the trash
POST /api/v3/unschedule_email - Cancel a scheduled send
POST /api/v3/update_campaign_sharing - Change how a campaign is shared on the web
POST /api/v3/update_email - Update a campaign draft
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_iys_summary - Get the registry filing status
GET /api/v3/get_opt_outs - List opt-out records
POST /api/v3/record_consent - Record a consent
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/create_contact_list - Create a new contact list
POST /api/v3/delete_contact_list - Delete a contact list
GET /api/v3/get_contact_list - Get a single contact list
GET /api/v3/get_contact_list_contacts - List contacts in a contact list
GET /api/v3/get_contact_lists - List all contact lists
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/add_contact_note - Write a note on a contact
POST /api/v3/create_contact - Create a new contact
POST /api/v3/create_or_update_contact - Create or update a contact
POST /api/v3/delete_contact - Delete a contact
GET /api/v3/get_contact - Get a single contact
GET /api/v3/get_contact_activity - Get one contact's activity timeline
GET /api/v3/get_contact_fields - List available contact fields
GET /api/v3/get_contact_subscriptions - Get what one contact is subscribed to
GET /api/v3/get_contacts - List all contacts
GET /api/v3/get_import - Get one import and its progress
POST /api/v3/import_contacts - Import contacts from a CSV
GET /api/v3/list_imports - List contact imports
POST /api/v3/remove_tags_from_contact - Remove tags from a contact
GET /api/v3/search_contacts - Search contacts
POST /api/v3/update_contact - Update an existing contact
POST /api/v3/update_contact_subscriptions - Change what one contact is subscribed to
POST /api/v3/create_custom_block - Save a content block
POST /api/v3/delete_custom_block - Delete a content block
GET /api/v3/get_custom_block - Get one content block
GET /api/v3/list_custom_blocks - List saved content blocks
POST /api/v3/update_custom_block - Update a content block
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
GET /api/v3/get_custom_fields - List all custom fields
GET /api/v3/list_domain_health_checks - List saved domain health checks
POST /api/v3/run_domain_health_check - Run a domain health check
GET /api/v3/get_email_senders - List verified email senders
GET /api/v3/list_senders - List available senders
POST /api/v3/create_email_template - Create an email template
POST /api/v3/delete_email_template - Delete an email template
GET /api/v3/get_email_template - Get a single email template
GET /api/v3/get_email_templates - List email templates
POST /api/v3/update_email_template - Update an email template
POST /api/v3/create_email_type - Create an email type
GET /api/v3/get_email_types - List email types
POST /api/v3/create_emails - Create email drafts
GET /api/v3/email_status - Check email draft status
POST /api/v3/send_email - Send an email draft
POST /api/v3/create_form - Create a signup or lead form
POST /api/v3/delete_form - Delete a form
GET /api/v3/get_form - Get a single form
GET /api/v3/get_form_responses - List form submissions
GET /api/v3/get_forms - List forms
POST /api/v3/update_form - Update a form
GET /api/v3/get_endpoints - List webhook endpoints
GET /api/v3/get_integrations - List active integrations
POST /api/v3/create_landing_page - Create a landing page
GET /api/v3/get_page - Get a single landing page
GET /api/v3/get_pages - List landing pages
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
POST /api/v3/update_landing_page - Update a landing page
POST /api/v3/delete_file - Remove a file from the gallery
GET /api/v3/list_files - List hosted files
GET /api/v3/list_images - List the image library
POST /api/v3/upload_file - Upload a file to the gallery
POST /api/v3/upload_image - Upload an image
POST /api/v3/create_sms_campaign - Create an SMS campaign
GET /api/v3/get_sms_campaign - Get a single SMS campaign
GET /api/v3/get_sms_campaigns - List SMS campaigns
POST /api/v3/send_sms_campaign - Submit an SMS campaign for sending
POST /api/v3/update_sms_campaign - Update an SMS campaign
POST /api/v3/create_segment - Create a segment
POST /api/v3/delete_segment - Delete a segment
GET /api/v3/get_segments - List saved segments
POST /api/v3/refresh_segment - Recalculate a segment
POST /api/v3/update_segment - Update a segment
POST /api/v3/add_domain - Add a sending domain
POST /api/v3/create_reply_to_address - Add a reply-to address
POST /api/v3/create_sender - Create a sender address
POST /api/v3/delete_sender - Remove a sender address
GET /api/v3/list_domains - List sending domains
GET /api/v3/list_reply_to_addresses - List reply-to addresses
POST /api/v3/remove_domain - Archive a sending domain
POST /api/v3/verify_domain - Check a domain's DNS records
POST /api/v3/create_signature - Create an email signature
POST /api/v3/delete_signature - Delete an email signature
GET /api/v3/get_signatures - List email signatures
POST /api/v3/update_signature - Update an email signature
GET /api/v3/get_suppressions - List suppressed emails
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/delete_tag - Delete a tag
GET /api/v3/get_tags - List all tags
POST /api/v3/update_tag - Rename or recolor a tag
POST /api/v3/add_global_email_unsubscriber - Globally unsubscribe an email
POST /api/v3/add_global_sms_unsubscriber - Unsubscribe from SMS
POST /api/v3/remove_global_email_unsubscriber - Resubscribe an email
POST /api/v3/remove_global_sms_unsubscriber - Resubscribe to SMS
POST /api/v3/create_endpoint - Create a webhook endpoint
POST /api/v3/delete_endpoint - Delete a webhook endpoint

MCP Server for AI Tools

Mailsoftly provides an MCP (Model Context Protocol) server for AI-powered email marketing. Connect Claude Desktop, Cursor, or any MCP client to manage contacts, send campaigns, and automate workflows using natural language.

AI Integration & MCP Server
for Mailsoftly Email Marketing & Automation Platform

Connect Claude, ChatGPT, Gemini, Grok, Copilot, Cursor, and any MCP-compatible client to manage your email campaigns, contacts, and automations using natural language.

Claude

Mailsoftly is listed in the Claude directory: one click to connect, OAuth sign-in, sending as a separate permission. How it works.

MCP Server

One hosted server for every assistant and coding tool that speaks Model Context Protocol. Setup and the tool list.

ChatGPT / GPT Actions

Use Mailsoftly's OpenAPI spec with ChatGPT GPT Actions for AI-powered email campaign management.

Google Gemini

Import the OpenAPI spec as a Vertex AI Extension to manage email marketing via Gemini.

Grok / xAI

Use Mailsoftly's API with Grok's tool-use and function calling capabilities.

GitHub Copilot

Copilot discovers Mailsoftly's API via llms.txt and OpenAPI spec for code generation.

143 API Endpoints

All Mailsoftly email marketing API endpoints available - contacts, lists, tags, emails, automations, and more.

Claude Desktop Configuration

{
  "mcpServers": {
    "mailsoftly": {
      "command": "node",
      "args": ["/path/to/mailsoftly/mcp-server/build/index.js"],
      "env": {
        "API_KEY_API_KEY": "your-mailsoftly-api-key"
      }
    }
  }
}

Full MCP Documentation View API Reference Download OpenAPI Spec Learn about MCP