# Mailercloud API

> Send campaigns, manage contacts, and automate email with the Mailercloud API.

## Docs

- [Use with AI tools](https://apidoc.mailercloud.com/ai-tools.md): Connect Claude, Cursor, ChatGPT, and other AI assistants to the Mailercloud API documentation.
- [Client Details](https://apidoc.mailercloud.com/api-reference/account/client-details.md): API to get current user details
- [Create Automation](https://apidoc.mailercloud.com/api-reference/automations/create-automation.md): API to create an advanced automation in a single request. `name` and `nodes` are required. `auto_publish` is optional (defaults to `false` = draft). `timezone`, `start_time`, `end_time`, `allow_re_enrollment`, `re_enroll_interval`, `re_enroll_unit` are optional.
- [Get Automation Details](https://apidoc.mailercloud.com/api-reference/automations/get-automation-details.md): Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.
- [Download Verification Results](https://apidoc.mailercloud.com/api-reference/bulk-files/download-verification-results.md): Download the verified results file for a completed verification.
- [Get File Verification Status](https://apidoc.mailercloud.com/api-reference/bulk-files/get-file-verification-status.md): Poll the processing status and result summary of an uploaded file.
- [List Verification Files](https://apidoc.mailercloud.com/api-reference/bulk-files/list-verification-files.md): List your uploaded verification files with pagination and search.
- [Upload File for Verification](https://apidoc.mailercloud.com/api-reference/bulk-files/upload-file-for-verification.md): Upload a file of email addresses for bulk verification. Max **10 MB** and **100,000 emails** per file. Processing is asynchronous — poll `GET /verifyFileStatus/{file_id}`. (These are the API upload limits; larger files — up to 100 MB / 1M addresses in CSV/TXT — can be verified through the in-app Lis…
- [Campaign Domain Report](https://apidoc.mailercloud.com/api-reference/campaigns/campaign-domain-report.md): This report contains statistics for the top-performing email domains in a campaign. The domains report allows you to break down your customers into groups according to their mailbox service provider.
- [Campaign List](https://apidoc.mailercloud.com/api-reference/campaigns/campaign-list.md): Get the details of all the campaigns you have created.
- [Create Campaign](https://apidoc.mailercloud.com/api-reference/campaigns/create-campaign.md): > A newer version of this endpoint with more options is available: [Create Campaign (v2)](/api-reference/campaigns/create-campaign-v2).
- [Create Campaign (v2)](https://apidoc.mailercloud.com/api-reference/campaigns/create-campaign-v2.md): **The newer version of Create Campaign with additional options — prefer this endpoint for new integrations.**
- [Get Single Campaign Details](https://apidoc.mailercloud.com/api-reference/campaigns/get-single-campaign-details.md): Get the details of a single campaign.
- [List Campaign Clicks](https://apidoc.mailercloud.com/api-reference/campaigns/list-campaign-clicks.md): Get a paginated list of contacts who clicked a link in a specific campaign.
- [List Campaign Opens](https://apidoc.mailercloud.com/api-reference/campaigns/list-campaign-opens.md): Get a paginated list of contacts who opened a specific campaign.
- [List Campaign Unsubscribes](https://apidoc.mailercloud.com/api-reference/campaigns/list-campaign-unsubscribes.md): Get a paginated list of contacts who unsubscribed via a specific campaign.
- [Schedule Campaign](https://apidoc.mailercloud.com/api-reference/campaigns/schedule-campaign.md): API for scheduling campaign. If the schedule_at  is not given, the campaign will schedule for the current time.
- [Send a Test Email](https://apidoc.mailercloud.com/api-reference/campaigns/send-a-test-email.md): Send a test email.
- [Testmail Group List](https://apidoc.mailercloud.com/api-reference/campaigns/testmail-group-list.md): Get the details of all the testmail groups you have created.
- [Update Campaign](https://apidoc.mailercloud.com/api-reference/campaigns/update-campaign.md): API for updating the campaign. Can't change or edit the list, segments, pause_rule, rules for the campaigns in sending status. Pause the campaign to edit the scheduled date.
- [Create Batch Contact](https://apidoc.mailercloud.com/api-reference/contacts/create-batch-contact.md): Create a  Batch contact. You can create a maximum of 50 contact through this API.
- [Create Contact](https://apidoc.mailercloud.com/api-reference/contacts/create-contact.md): API for creating contact. For creating a contact, email and list id is required. If you try to create a contact that already exists, it gives an "already exists" message . You can add custom property data by mapping the property id : value. You can add contacts until your contact quota limit is reac…
- [Create or Update Contact](https://apidoc.mailercloud.com/api-reference/contacts/create-or-update-contact.md): API to manage your contacts, allowing you to either create new contacts or update existing ones based on your needs.
- [Delete Contact](https://apidoc.mailercloud.com/api-reference/contacts/delete-contact.md): Delete a contact based on their ID
- [Get Contact Details](https://apidoc.mailercloud.com/api-reference/contacts/get-contact-details.md): Get contact details based on their Contact ID or Email
- [Get Contacts in a List](https://apidoc.mailercloud.com/api-reference/contacts/get-contacts-in-a-list.md): You can collect all your contacts on a single list.
- [Remove Contact Tag](https://apidoc.mailercloud.com/api-reference/contacts/remove-contact-tag.md): API to remove contact-tags from individual contacts
- [Update Contact](https://apidoc.mailercloud.com/api-reference/contacts/update-contact.md): Update contact details based on contact ID or Email using this API. However, you can't update the list ID and email.
- [Create Property](https://apidoc.mailercloud.com/api-reference/custom-properties/create-property.md): API for creating custom property of contacts. Custom properties store specific information for contact records in Mailercloud. You are allowed to create a maximum of 100 properties.
- [Delete Property](https://apidoc.mailercloud.com/api-reference/custom-properties/delete-property.md): API for deleting custom property of contacts. If the property is used in a webform you won't be able to delete it.
- [List Property](https://apidoc.mailercloud.com/api-reference/custom-properties/list-property.md): Using this API, you can list all the properties of your contacts in your Mailercloud account. You can also make segments based on these properties
- [Update Property](https://apidoc.mailercloud.com/api-reference/custom-properties/update-property.md): API for updating custom property of contacts. Editing custom property type using this API is not possible. You can only edit the name and description.
- [List Inbox-Tracking Campaigns](https://apidoc.mailercloud.com/api-reference/email/list-inbox-tracking-campaigns.md): API to get inbox tracking details for Email API campaigns. Returns a paginated list of campaigns enriched with inbox / spam / missed placement percentages and a per-mailbox-provider breakdown. Supports filtering by campaign id, subject, sender and date range, plus sorting on key metrics.
- [Send Email](https://apidoc.mailercloud.com/api-reference/email/send-email.md): Send a single email — transactional (order confirmations, OTPs, notifications) or promotional — through the Mailercloud Email API. Supports plain text, HTML, AMP content, attachments, and multiple recipients (To, CC, BCC).
- [Send Personalized Email](https://apidoc.mailercloud.com/api-reference/email/send-personalized-email.md): Send transactional or marketing emails with **per-recipient personalization** (mail merge). Same request structure as `POST /email`, plus an optional `merge_vars` object on each `recipients.to[]` entry.
- [Inbox-tracking](https://apidoc.mailercloud.com/api-reference/inbox-tracker/inbox-tracking.md): API to get inbox tracking details. Date period is required (date_from & date_to), campaign_id is optional, domain is optional
- [Create a New List](https://apidoc.mailercloud.com/api-reference/lists/create-a-new-list.md): Your Mailercloud list, also known as your recipient, is where you store and manage all of your contacts.
- [Delete a List](https://apidoc.mailercloud.com/api-reference/lists/delete-a-list.md): This API deletes a specific list by id. However, you can't delete your list if its used in an active campaign , active automation or in an active webform .
- [Get Single List Details](https://apidoc.mailercloud.com/api-reference/lists/get-single-list-details.md): Get single list details based on id.
- [List Lists](https://apidoc.mailercloud.com/api-reference/lists/list-lists.md): Use this API to return an array of all of your contact lists. You can filter, search  and sort list.
- [Update a List](https://apidoc.mailercloud.com/api-reference/lists/update-a-list.md): Update the details of a specific list by id. However, you can only update the names using this API
- [Create Segment](https://apidoc.mailercloud.com/api-reference/segments/create-segment.md): API to create a segment in a single request. `name`, `match` and `rules` are required. `lists` is optional - if omitted, the segment evaluates against all contacts.
- [List Segment](https://apidoc.mailercloud.com/api-reference/segments/list-segment.md): List all your created segments.
- [Update a Segment](https://apidoc.mailercloud.com/api-reference/segments/update-a-segment.md): Update an existing segment by id. The full segment definition is replaced - this is NOT a partial update. Send the complete `name`, `match`, `rules` (and optional `lists`) on every call.
- [List Reply Emails](https://apidoc.mailercloud.com/api-reference/senders/list-reply-emails.md): Use this API to return an array of all your active reply-to email addresses. You can filter and search reply emails with pagination.
- [List Senders](https://apidoc.mailercloud.com/api-reference/senders/list-senders.md): Use this API to return an array of all your active and verified sender email addresses with sender name and reply-to email. You can filter, search and sort senders.
- [Create Tag](https://apidoc.mailercloud.com/api-reference/tags/create-tag.md): API for creating tags for contacts and campaign.
- [Delete Tag](https://apidoc.mailercloud.com/api-reference/tags/delete-tag.md): This API deletes a specific tag by id.
- [List Tags](https://apidoc.mailercloud.com/api-reference/tags/list-tags.md): Using this API, you can list all the tags of your contacts and campaign in your Mailercloud account
- [Update Tag](https://apidoc.mailercloud.com/api-reference/tags/update-tag.md): API for updating tag name of contacts and campaign.
- [Create Template](https://apidoc.mailercloud.com/api-reference/templates/create-template.md): API to create a new template in Mailercloud.
- [Get Template by Name or ID](https://apidoc.mailercloud.com/api-reference/templates/get-template-by-name-or-id.md): This endpoint retrieves the full details of an email template in mailercloud. You can fetch a template either by passing the template name or its ID in the query parameters.
- [Get Template Categories](https://apidoc.mailercloud.com/api-reference/templates/get-template-categories.md): This API endpoint is used to list the template categories in Mailercloud.
- [Get Template Details](https://apidoc.mailercloud.com/api-reference/templates/get-template-details.md): This API endpoint is used to retrieve the details of a specific email template by its ID in Mailercloud.
- [List Templates](https://apidoc.mailercloud.com/api-reference/templates/list-templates.md): Get a list of your saved email templates.
- [Update Template](https://apidoc.mailercloud.com/api-reference/templates/update-template.md): This API allows you to update an existing email template in Mailercloud. You can update a template either by providing its id or by using the templateName — at least one of them is required.
- [Verify Emails](https://apidoc.mailercloud.com/api-reference/verification/verify-emails.md): Verify a single email or a batch of up to **50** emails in real time. Duplicates are removed automatically. Each billable result consumes one credit; returns `402` when the account has insufficient credits. Credits are consumed for every verification attempt, including `unknown` results. Same credit…
- [Webform List](https://apidoc.mailercloud.com/api-reference/webforms/webform-list.md): Use this API to return an array of all of your webforms. You can filter, search and sort webforms.
- [Create a New Webhook](https://apidoc.mailercloud.com/api-reference/webhooks/create-a-new-webhook.md): Mailercloud webhook is a mechanism that allows external systems to receive real-time updates and notifications about events occurring within your account.
- [Delete a Webhook](https://apidoc.mailercloud.com/api-reference/webhooks/delete-a-webhook.md): This API deletes a specific webhook by id.
- [Get Webhook Details](https://apidoc.mailercloud.com/api-reference/webhooks/get-webhook-details.md): Get webhook details based on their ID
- [Search and List Webhooks](https://apidoc.mailercloud.com/api-reference/webhooks/search-and-list-webhooks.md): API to list all webhooks with the ability to search, filter, and sort the results.
- [Test Webhook](https://apidoc.mailercloud.com/api-reference/webhooks/test-webhook.md): API to send dummy trigger requests to the webhook URL for testing purposes.
- [Toggle Webhook Status](https://apidoc.mailercloud.com/api-reference/webhooks/toggle-webhook-status.md): API for deactivating or activating the status of a webhook.
- [Update a Webhook](https://apidoc.mailercloud.com/api-reference/webhooks/update-a-webhook.md): API for modifying webhook information. This allows you to update the webhook's name, URL, and events.
- [Authentication](https://apidoc.mailercloud.com/authentication.md): Authenticate to the Mailercloud API with an API key in the authorization header.
- [Conventions & versioning](https://apidoc.mailercloud.com/conventions.md): Naming conventions per product, pagination, API versions, idempotency, and SDK status.
- [Errors](https://apidoc.mailercloud.com/errors.md): Error formats for every Mailercloud API product, the Email API internal status-code table, and which errors are retryable.
- [Sync contacts in real time](https://apidoc.mailercloud.com/guides/contact-sync.md): Push signups from your website, app, or CRM into Mailercloud lists as they happen.
- [Mailercloud MCP server](https://apidoc.mailercloud.com/guides/mcp-server.md): Let AI agents act on your Mailercloud account — create campaigns, manage contacts, send email, and analyze performance via the Model Context Protocol.
- [Quickstart: send your first campaign](https://apidoc.mailercloud.com/guides/quickstart.md): Create a list, add a contact, and send your first email campaign in five minutes.
- [Send via SMTP relay](https://apidoc.mailercloud.com/guides/smtp-relay.md): Send transactional email through Mailercloud's SMTP relay from any framework, CMS, or legacy system — no code changes beyond SMTP settings.
- [Send transactional email](https://apidoc.mailercloud.com/guides/transactional-email.md): Send order confirmations, OTPs, and notifications with the Mailercloud Email API from PHP, Node.js, or any HTTP client.
- [Connect forms to your audience](https://apidoc.mailercloud.com/guides/webforms.md): Grow lists from your website: Mailercloud webforms, or wire any third-party form (Wix, WordPress, custom) to the contacts API.
- [Set up webhooks](https://apidoc.mailercloud.com/guides/webhooks.md): Receive real-time notifications in your systems when campaigns send, open, click, bounce, or unsubscribe.
- [Introduction](https://apidoc.mailercloud.com/index.md): The Mailercloud API provides access to Mailercloud data and functionality — sync data, manage contacts and lists, create campaigns, and send email programmatically.
- [Rate limits & retries](https://apidoc.mailercloud.com/rate-limits.md): Request limits per product, what a 429 looks like, and how to implement correct backoff.

## OpenAPI Specs

- [openapi-v1](https://apidoc.mailercloud.com/openapi-v1.json)
- [openapi-verifier](https://apidoc.mailercloud.com/openapi-verifier.json)
- [openapi-emailapi](https://apidoc.mailercloud.com/openapi-emailapi.json)