Mailercloud integration: operations for AI agents
Mailercloud connects to Type.com as an integration. This page lists the 82 operations documented for Claude and Codex in Type.com: 33 read, 34 write, 15 destructive.
About Mailercloud
Powerful and simple all-in-one email marketing platform providing effective solutions for rapid business growth.
Categories: Marketing & Social
How to connect Mailercloud to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
82 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
82 operations listed.
Campaigns
- Read
Get Single Campaign Details
Get the details of a single campaign.
- Read
List Campaign Opens
Get a paginated list of contacts who opened a specific campaign.
- Read
List Campaign Clicks
Get a paginated list of contacts who clicked a link in a specific campaign.
- Read
List Campaign Unsubscribes
Get a paginated list of contacts who unsubscribed via a specific campaign.
- Write
Create Campaign
A newer version of this endpoint with more options is available: Create Campaign (v2). API for creating an email campaign. For creating a campaign, HTML or plain text and list id or segment are mandatory.
- Write
Create Campaign (v2)
The newer version of Create Campaign with additional options — prefer this endpoint for new integrations. Required: name, subject, and sender (with sendername + senderemail). Content: provide html or plaintext. Audience: provide at least one of listids, segments, or tagids.
- Write
Campaign Domain Report
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.
- Write
Campaign List
Get the details of all the campaigns you have created.
- Write
Testmail Group List
Get the details of all the testmail groups you have created.
- Write
Schedule Campaign
API for scheduling campaign. If the scheduleat is not given, the campaign will schedule for the current time.
- Write
Send a Test Email
Send a test email.
- Destructive
Update Campaign
API for updating the campaign. Can't change or edit the list, segments, pauserule, rules for the campaigns in sending status. Pause the campaign to edit the scheduled date.
Custom Properties
- Read
List Property
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
- Write
Create Property
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.
- Write
Update Property
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.
- Destructive
Delete Property
API for deleting custom property of contacts. If the property is used in a webform you won't be able to delete it.
Contacts
- Read
Get Contact Details
Get contact details based on their Contact ID or Email
- Read
Get Contacts in a List
You can collect all your contacts on a single list.
- Write
Create Contact
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.
- Write
Create or Update Contact
API to manage your contacts, allowing you to either create new contacts or update existing ones based on your needs. When you send a request, the API first checks if the contact already exists in your database.
- Write
Create Batch Contact
Create a Batch contact. You can create a maximum of 50 contact through this API.
- Destructive
Update Contact
Update contact details based on contact ID or Email using this API. However, you can't update the list ID and email.
- Destructive
Delete Contact
Delete a contact based on their ID
- Destructive
Remove Contact Tag
API to remove contact-tags from individual contacts When you send a request, the API first checks if the contact already exists in your database. If the contact is found, the API will check if the tags you provided are valid. You can give both tag names or tag ids.
Lists
- Read
Get Single List Details
Get single list details based on id.
- Read
List Lists
Use this API to return an array of all of your contact lists. You can filter, search and sort list.
- Write
Create a New List
Your Mailercloud list, also known as your recipient, is where you store and manage all of your contacts.
- Write
Update a List
Update the details of a specific list by id. However, you can only update the names using this API
- Destructive
Delete a List
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 .
Segments
- Read
List Segment
List all your created segments.
- Write
Create Segment
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. A segment is a dynamic contact filter built from a list of rules.
- Destructive
Update a Segment
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. On success, the segment's activecount is recomputed asynchronously.
Senders
- Read
List Senders
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.
- Read
List Reply Emails
Use this API to return an array of all your active reply-to email addresses. You can filter and search reply emails with pagination.
- Write
Add a Sender
Add a sender (from address) on a verified domain — the same as Add sender in Account Settings → Senders. A sender on a verified domain is verified at once (no confirmation email). The address fields are optional; any you leave out are taken from your account profile.
- Destructive
Delete a Sender
Delete a sender — the same as Delete in Account Settings → Senders. This cannot be undone.
Account
- Read
Client Details
API to get current user details
Webforms
- Write
Webform List
Use this API to return an array of all of your webforms. You can filter, search and sort webforms.
Tags
- Read
List Tags
Using this API, you can list all the tags of your contacts and campaign in your Mailercloud account
- Write
Create Tag
API for creating tags for contacts and campaign.
- Destructive
Update Tag
API for updating tag name of contacts and campaign.
- Destructive
Delete Tag
This API deletes a specific tag by id.
Webhooks
- Read
Get Webhook Details
Get webhook details based on their ID
- Read
Search and List Webhooks
API to list all webhooks with the ability to search, filter, and sort the results.
- Write
Create a New Webhook
Mailercloud webhook is a mechanism that allows external systems to receive real-time updates and notifications about events occurring within your account.
- Write
Test Webhook
API to send dummy trigger requests to the webhook URL for testing purposes.
- Write
Toggle Webhook Status
API for deactivating or activating the status of a webhook.
- Destructive
Update a Webhook
API for modifying webhook information. This allows you to update the webhook's name, URL, and events.
- Destructive
Delete a Webhook
This API deletes a specific webhook by id.
Templates
- Read
Get Template Details
This API endpoint is used to retrieve the details of a specific email template by its ID in Mailercloud.
- Read
List Templates
Get a list of your saved email templates. By default the response returns only template metadata (id, name, type, status, dates) — fast and small, ideal for building a template picker or dashboard.
- Read
Get Template Categories
This API endpoint is used to list the template categories in Mailercloud.
- Read
Get Template by Name or ID
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.
- Write
Create Template
API to create a new template in Mailercloud. Required Fields: - name: Name of the template (required, max 100 characters, must be unique) - html: Specifies the HTML content (required) Optional Fields: - categoryId: Specifies the category ID of the template, you can get it from t…
- Write
Update Template
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. Required Fields: - id: The unique ID of the template you want to update.
Automations
- Read
Get Automation Details
Retrieve details and node-level campaign report data for an advanced automation by its ID. The request body filters which node types are included.
- Write
Create Automation
API to create an advanced automation in a single request. name and nodes are required. autopublish is optional (defaults to false = draft). timezone, starttime, endtime, allowreenrollment, reenrollinterval, reenrollunit are optional.
Domains
- Read
List Domains
List the sending domains in your account with their status — the same domains and statuses as Account Settings → Domains in the app. Filter by status to find the domains that still need DNS work, and search by name.
- Read
Get a Domain
Get one domain with its DNS records and the status of each record — the same records as Account Settings → Domains in the app. The response is the same domain object as Add a Domain. The statuses come from the last DNS check (domains are re-checked automatically).
- Write
Add a Domain
Add a sending domain to your account and get the DNS records to publish at your DNS provider.
- Write
Verify a Domain
Check the domain's DNS records now and update its status — the same as Verify in Account Settings → Domains. The response is the same domain object as Get a Domain, with each record's new status.
- Destructive
Update a Domain
Change one or more DNS record host labels and/or open tracking in one call — the same changes as the edit (pencil) icon and the open-tracking toggle in Account Settings → Domains. Send at least one field. All fields are checked first; if any is invalid nothing is changed.
- Destructive
Delete a Domain
Delete a domain — the same as Delete in Account Settings → Domains. This cannot be undone. Senders on this domain can no longer send, and the DNS records Mailercloud hosts for it are removed. You can remove the domain's records from your DNS provider afterwards.
Inbox Tracker
- Read
List placement providers
Mailbox providers you can pick for a placement test, grouped by region and market. Use the provider id values in providerids when you start a test. Spam-filter checks are added to every test automatically and are not listed.
- Read
Get a placement test
Full result of one placement test: placement per provider and market, Gmail tabs, authentication, spam-filter verdicts, blocklists, content checks and a list of issues with fixes. While status is running, the numbers fill in as seeds report.
- Read
Get a campaign's latest placement test
Summary of the campaign's newest placement test. data is null when the campaign has never been tested. draftchanged is true when the draft was edited after that test.
- Read
List a campaign's placement tests
The campaign's placement tests, newest first, up to 20. presend tests are the ones you start; postsend is the automatic test taken when the campaign is sent. inboxpct is set only for completed tests.
- Read
Get placement test quota
Your placement test allowance. active is true only with an active Advanced Inbox Tracker add-on on a paid plan.
- Write
Inbox-tracking
API to get inbox tracking details. Date period is required (datefrom & dateto), campaignid is optional, domain is optional
- Write
Start a placement test
Sends a draft campaign to seed mailboxes at the chosen providers and reports where it lands (inbox, Gmail tabs, spam, missing). Each test uses one test from your Advanced Inbox Tracker allowance. Only draft regular campaigns with a subject, sender and content can be tested.
Verification
- Write
Verify Emails
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.
Bulk Files
- Read
List Verification Files
List your uploaded verification files with pagination and search.
- Read
Get File Verification Status
Poll the processing status and result summary of an uploaded file.
- Read
Download Verification Results
Download the verified results file for a completed verification.
- Write
Upload File for Verification
Upload a file of email addresses for bulk verification. Max 10 MB and 100,000 emails per file. Processing is asynchronous — poll GET /verifyFileStatus/{fileid}.
- Read
List Inbox-Tracking Campaigns
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.
- Read
Search Suppressions
Returns the recipients on your suppression list, newest first. Narrow the result with a search term, a reason, or a date range, and page through it with page or by following nextcursor. A suppressed recipient is rejected on every future send until it is reactivated. Sample Code
- Write
Send Email
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).
- Write
Send Personalized Email
Send transactional or marketing emails with per-recipient personalization (mail merge). Same request structure as POST /email, plus an optional mergevars object on each recipients.to[] entry.
- Write
Add Suppressions
Adds one or more recipients to your suppression list. They are rejected on every future send until reactivated.
- Destructive
Reactivate a Suppressed Recipient
Removes a recipient from your suppression list so it can receive mail again. The change applies to the next send.
No operations match.
See How connections work for access and permissions, or browse all integrations.