Mailsoftly integration: operations for AI agents
Mailsoftly connects to Type.com as an integration. This page lists the 153 operations documented for Claude and Codex in Type.com: 62 read, 71 write, 20 destructive.
About Mailsoftly
Mailsoftly is an intuitive email marketing platform designed to simplify and enhance how businesses communicate with their audiences. Built with user-friendly features and advanced automation tools, Mailsoftly helps organizations to create, schedule, and manage email campaigns easily.
Categories: Marketing & Social
How to connect Mailsoftly to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
153 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.
153 operations listed.
Authentication
- Write
Verify API credentials
Validates your API access token and returns basic account information. Use this endpoint to verify that your token is valid before making other API calls.
Contacts
- Read
List all contacts
Returns all contacts belonging to your account. Each contact includes basic fields: id, firstname, lastname, email, createdat and updatedat. Detailed contact information including custom fields comes from GET /getcontact with type=detailed.
- Read
Get a single contact
Returns a single contact by ID. By default returns a summary (id, firstname, lastname, email). Pass type=detailed to get all contact fields including custom fields, address, and metadata.
- Read
List available contact fields
Returns the list of all available contact fields and their database types. Internal fields (firmid, userid, etc.) are excluded. Use this to discover which fields you can set when creating or updating contacts.
- Read
Search contacts
Search for contacts by exact match on email, firstname, or lastname. All search parameters use exact matching (not partial/fuzzy). Returns matching contacts with basic fields (id, firstname, lastname, email, source).
- Read
Get one contact's activity timeline
Everything the account knows about what happened with one contact, merged into a single newest first timeline: subscription and list events with the source they came from, the campaign mail this contact was sent with its opens and clicks, and the notes teammates wrote on the rec…
- Read
Get one import and its progress
Reads one contact import in this account by id: its status, how many rows it carries, how many have been processed, the success and failure counts and the first lines of any error report. It follows an import started with importcontacts.
- Read
List contact imports
Lists the contact imports in this account, newest first, with the same progress fields getimport returns. Filter to one list with contactlistid. It carries the import id of a recent import when that id is not at hand.
- Read
Get what one contact is subscribed to
Reads the full subscription picture for one contact: the account-wide sending status, whether the address is globally unsubscribed or suppressed, and one row per email type saying whether the contact accepts it, who opted them out and when.
- Write
Create a new contact
Creates a new contact in your account. The email field is required and must be unique within your account. All other fields are optional. Returns the full contact object on success (excluding internal fields).
- Write
Update an existing contact
Updates an existing contact's fields. Only the fields present in the request body are updated. All other fields remain unchanged. dateofbirth takes YYYY-MM-DD, or --MM-DD for a birthday without its year.
- Write
Create or update a contact
Creates a new contact or updates an existing one. Important behavior: - If contactid is provided, the existing contact with that ID is updated. A contactid that matches no contact creates a new one.
- Write
Write a note on a contact
Records a plain text note on one contact, the same note the account's team sees on the contact page and the same note getcontactactivity returns.
- Write
Import contacts from a CSV
Imports contacts from a CSV passed as a string in the request body, into an existing list (contactlistid) or a new one (contactlistname).
- Write
Change what one contact is subscribed to
Subscribes or unsubscribes one contact from email types, by id. Unsubscribing records a consent change the account made on the contact's behalf.
- Destructive
Delete a contact
Permanently deletes one contact with its list memberships, tags and activity. Irreversible. To stop mail without losing the record, add a global unsubscribe instead.
- Destructive
Remove tags from a contact
Removes one or more tags from a contact by tagids or tagnames. The tags themselves stay defined.
Contact Lists
- Read
List all contact lists
Returns all contact lists in your account with their contact counts. Only "general" type lists are returned (internal system lists are excluded). Note on field naming. This endpoint returns contactcount (singular).
- Read
Get a single contact list
Returns details of a single contact list including its contact count. Note on field naming. This endpoint returns the count as contactscount (plural), while GET /getcontactlists (the list endpoint) returns the same value as contactcount (singular). Both mean the same thing.
- Read
List contacts in a contact list
Returns the contacts belonging to a specific contact list. Each row carries id, firstname, lastname, email, createdat, updatedat and addedat, the time the contact was added to this list.
- Write
Create a new contact list
Creates a new empty contact list. The add contact endpoints populate it.
- Write
Add a single contact to a list
Adds an existing contact to an existing contact list. If the contact is already in the list, returns an info message (not an error).
- Write
Add multiple contacts to a list
Adds multiple contacts to a contact list at once. Contacts are matched by email. If a contact with the given email doesn't exist, it will be created. Contacts without an email address are skipped and reported in the errors array.
- Write
Rename a contact list
Changes a contact list's name. Memberships, automations and campaigns that use the list are unaffected.
- Destructive
Remove a contact from a list
Takes one contact off one list. The contact record is untouched.
- Destructive
Delete a contact list
Deletes a list. Its contacts remain in the account. Refused (422) while an automation starts from the list or while any campaign, sent, draft or trashed, still has the list as its audience; the response names those campaigns in blockingcampaignids.
Tags
- Read
List all tags
Returns all contact tags in your account. Tags are used to categorize and segment contacts. Each tag has a name and color (in RGB format). Only contact-type tags are returned (not internal tags used for other resources).
- Write
Assign a tag to a contact
Assigns a single tag to a contact. You can either: - Pass tagid to assign an existing tag, or - Pass tagname to find or create a tag by name (optionally with tagcolor). Tag colors can be in hex format (FF0000) or RGB format (rgb(255,0,0)).
- Write
Assign multiple tags to a contact
Assigns multiple tags to a contact at once. Tags that do not exist are created. Tags already assigned to the contact are skipped, not duplicated.
- Write
Create a tag
Creates a contact tag, or returns the existing one with that name.
- Write
Rename or recolor a tag
Changes a tag's name or color; every contact carrying it follows.
- Destructive
Delete a tag
Deletes a tag and removes it from every contact. Refused while an automation starts from it.
Custom Fields
- Read
List all custom fields
Returns all custom fields defined for contacts in your account. Custom fields are key-value pairs where the key is the field name and the value is the field type (currently always "string").
- Write
Add a custom field to a contact
Sets a custom field value on a contact. If the custom field doesn't exist at the account level, it will be created automatically. Custom fields are stored as JSONB on the contact record.
- Write
Define a custom contact field
Defines a custom contact field (name, type text|number|date|select|multiselect, options for selects). Idempotent for an existing name. Values are then set with addcustomfieldtocontact.
Emails
- Read
Check email draft status
Returns the current status of an email draft and whether it's ready to send.
- Read
Get a transactional email's status
Status and event history of one transactional email, by messageid, or by referenceid (the most recent message with that reference). Same information the status webhook pushes, for reconciling or for receivers that missed an event.
- Read
Get the status webhook
The account's status webhook and how its last delivery went, or webhook: null when none is set. The signing secret is not included.
- Write
Create email drafts
Creates one or more email drafts: a single draft, or several at once through the mailLists array. Audience: give it one of three ways: - contactlistid: one existing list, OR - contactlistids and/or segmentids: several lists and segments.
- Write
Send an email draft
Sends an existing email draft. The draft must be in a ready state, which GET /emailstatus reports. Important: This endpoint only works with draft IDs created via POST /createemails.
- Write
Send a transactional email
Sends one email to one recipient and answers at once with a messageid. Use it for application email: notifications, confirmations, reminders, one-time links.
- Write
Create or update the status webhook
Sets the public https URL that receives transactional email status events (see sendtransactionalemail for the payload and signature). One webhook per account. The secret is returned when the webhook is created and when rotatesecret is true; store it then, it is not shown again.
- Write
Send a test event to the status webhook
Sends one signed event with event: "test" to the webhook now and reports what the receiver answered. Not retried. Use it to check the URL and your signature verification.
- Destructive
Remove the status webhook
Removes the account's status webhook. Statuses are still recorded and readable with getmessagestatus.
Unsubscribes
- Write
Globally unsubscribe an email
Globally unsubscribes an email address from all email communications. If a contact with this email doesn't exist, one will be created. This sets: - Contact's emailsendingstatus to unsubscribed - All email preferences to opt-out (campaign, newsletter, unsubscribeall)
- Write
Resubscribe an email
Resubscribes a previously unsubscribed email address. The contact must already exist. This sets: - Contact's emailsendingstatus to subscribed - All email preferences back to opt-in
- Write
Unsubscribe from SMS
Globally unsubscribes a contact from all SMS communications. Both email and phone are required. Phone must be in E.164 format (e.g., +1234567890). If a contact with this email doesn't exist, one will be created.
- Write
Resubscribe to SMS
Resubscribes a contact to SMS communications. The contact must already exist. Both email and phone are required. Phone must be in E.164 format.
Email Templates
- Read
List email templates
Returns all email templates in your account (id, name, subject, editor type, privacy setting).
- Read
Get a single email template
Returns details of a single email template by ID.
- Write
Create an email template
Saves a reusable template from complete HTML: name, subject and html. Usable in draftcampaign (templateid) and in automation sendemail steps.
- Write
Update an email template
Changes a template's name, subject or html.
- Destructive
Delete an email template
Deletes a template. Refused while an automation step sends it.
Email Senders
- Read
List available senders
Returns every from address the account can send a campaign from, in the order the in-app sender picker shows them, plus the sender the account falls back to. Every entry carries usableas, naming the POST /createemails parameter that selects it.
- Read
List verified email senders
Returns all verified sender email addresses (from, replyto, status).
Automations
- Read
List automations
Returns all email automations and drip campaigns (id, name, trigger type, active status).
- Read
Get a single automation
Returns one automation with its trigger and its steps in the createautomation vocabulary, so the steps read here can be edited and sent back in updateautomation's steps.
- Read
Get automation performance
How one automation is doing: how many contacts entered it and how many are in it now, the email totals the automations list shows, and per step how many contacts reached it.
- Write
Trigger an automation for a contact
Triggers an automation for a specific contact, starting the drip sequence.
- Write
Create an automation
Creates an automation as a draft with the same vocabulary as the in-app builder: one trigger, optional extra start events, an optional entry filter, and an ordered list of steps that can branch. Nothing runs until the automation is activated with POST /updateautomationstatus.
- Write
Activate or deactivate an automation
Set status to active or inactive. Activating starts real sends, so it needs a verified account (gate level account otherwise) and every step and trigger field complete (422 lists what is missing). Deactivating has no such requirement.
- Write
Update an automation
Edits an automation: name, trigger, extratriggers, entryfilter or steps. Uses exactly the vocabulary of POST /createautomation (trigger table, step kinds, branching).
- Write
Update one automation step
Changes one step in place: a sendemail step's template, subject, sender, reply-to or best-time setting, or how long a wait or waituntil step waits. The rest of the automation is untouched, and the step keeps its id, so its results in getautomationstats continue.
- Destructive
Delete an automation
Deletes an inactive automation and its steps. Deactivate first.
Forms
- Read
List forms
Returns all signup and subscription forms (id, name, token, status).
- Read
Get a single form
Returns details of a form including submission count and embed token.
- Read
List form submissions
Returns all submissions for a specific form.
- Write
Create a signup or lead form
Creates a signup or lead form from a simple field list. Email is always included and required.
- Write
Update a form
Changes a form's name, fields or linked list.
- Destructive
Delete a form
Deletes a form, its embed and its stored submissions. Contacts it created remain. Refused while an automation starts from it.
Landing Pages
- Read
List landing pages
Returns all landing pages (id, name, token, status, publish date).
- Read
Get a single landing page
Returns details of a landing page including its public URL and stats.
- Write
Create a landing page
Creates a landing page as an unpublished draft from complete HTML in the request. metatitle and metadescription set the page head; contactlistid turns on lead capture into that list; goal (optional) applies the builder's defaults for that goal.
- Write
Update a landing page
Changes a page's name, html, meta title, meta description or linked list.
- Write
Publish or unpublish a landing page
status published puts the page on the web (needs a verified account); unpublished takes it down.
- Write
Move a landing page to the trash
Unpublishes the page and moves it to the trash (reversible in the app).
SMS Campaigns
- Read
List SMS campaigns
Returns all SMS campaigns (id, name, message, status, sent count).
- Read
Get a single SMS campaign
Returns details of an SMS campaign including delivery stats.
- Write
Create an SMS campaign
Creates an SMS campaign draft to a list from a verified sender number, with the estimated credits. Sending is a separate call and goes through review.
- Write
Update an SMS campaign
Changes a draft SMS campaign's name, message or list.
- Write
Submit an SMS campaign for sending
Checks SMS credits and submits the campaign for the review every SMS campaign passes before it goes out. Insufficient credits return a gate with the purchase path.
Segments
- Read
List saved segments
Returns all saved contact segments/filters for targeted sends.
- Write
Create a segment
Creates a saved segment from contact-field conditions: {groups: [{join: and|or, conditions: [{field, operator, value}]}]} with the same fields and operators as automation entry filters. The member count is calculated in the background.
- Write
Update a segment
Changes a custom segment's name, description or conditions (conditions replaces the whole rule set). System segments cannot be edited.
- Write
Recalculate a segment
Recalculates a segment's member count in the background.
- Destructive
Delete a segment
Deletes a custom segment. Contacts are untouched. System segments cannot be deleted.
Integrations
- Read
List active integrations
Returns all active third-party integrations (Shopify, Zapier, etc.).
- Read
List webhook endpoints
Returns all user-created webhook endpoints for receiving external data.
Signatures
- Read
List email signatures
Returns all email signatures for the account.
- Write
Create an email signature
Saves an HTML signature for the connected user.
- Write
Update an email signature
Changes a signature's name, html or active flag.
- Destructive
Delete an email signature
Deletes a signature belonging to a team member of the account.
Suppressions
- Read
List suppressed emails
Returns all bounced and complained email addresses in the suppression list.
- Write
Add an address to the suppression list
Adds an email address to your account's suppression list, so no further mail from this account goes to it. When no contact has the address, one is created first (named from firstname and lastname, or 'Suppression Contact').
Account
- Read
Get account info
Returns your account/company profile information (name, domain, plan).
- Read
List team members
Returns all team members/users in your account (name, email, role).
- Read
List pending invitations
Lists the people who have been invited to this workspace but have not accepted yet. Takes no parameters and returns one row per invitation with the id, address, role, when it was sent and who sent it.
- Read
List the account's API keys
Lists the API keys issued for this account, showing which integrations still hold one and which are about to lapse.
- Read
List connected apps
Lists the third-party apps that currently hold access to this account, the way the Connected apps screen shows them. Takes no parameters and returns one row per app with the permissions it was granted, who approved it and when.
- Read
List the account's audit trail
Returns the append-only record of who changed what about this workspace: invitations sent, accepted and revoked, role changes, ownership transfers, people removed or deactivated, domain settings changed and contact imports and exports.
- Write
Invite a teammate
Sends an invitation email so a colleague can join this Mailsoftly workspace. Needs the email address and the role to give them, and optionally a first and last name.
- Write
Change a teammate's role
Changes the role of somebody who already belongs to this workspace. Takes userid (from getteammembers) and the new role, which has to be one this account may assign.
- Destructive
Revoke a pending invitation
Cancels an invitation that has not been accepted, so its link stops working. Takes the userid from listpendinginvitations.
Campaigns
- Read
List campaigns
Page through the account's campaigns, newest first: id, name, subject, status (draft, review, sending, sent, ...), recipients, senddate and headline counters. Filter with status and search with q.
- Read
Get campaign performance
Delivery and engagement statistics for a sent campaign: sent, delivered, opened, clicked, bounced, unsubscribed, complained, with open, click, bounce and unsubscribe rates. Unsent drafts return the campaign summary and a note.
- Read
Get a full campaign report
The whole performance picture for one sent campaign: headline counts and rates, the same rates averaged over every sent campaign in the account for comparison, the engagement split by recipient mailbox provider and by recipient domain, and cumulative open and click curves by hou…
- Read
Get per link clicks for a campaign
The click table behind a sent campaign: every address that was clicked, how many clicks and how many distinct recipients it drew, and its share of all clicks, busiest first.
- Read
List the recipients of a campaign
Who a sent campaign reached and what each of them did with it: address, contact id, when it was sent, when it was opened and clicked, and whether the address has since bounced or unsubscribed. Newest send first, paginated.
- Read
Preview who a campaign would go to
Who a campaign would actually reach if it went out now: which list or segment it targets, how many contacts that holds, how many of them are eligible recipients once suppressed, unsubscribed and opted out addresses are removed, the difference between the two, and up to five exam…
- Read
Get one campaign in full
Returns everything about a single campaign that listcampaigns leaves out: preheader, from address, reply-to, email type, segment, contact list name, A/B subject experiment, public sharing state, file attachments and whether a per-recipient PDF is attached.
- Write
Update a campaign draft
Edit an unsent draft in place: subject, body, name, replyto, the audience, or restart it from a saved template. The audience takes the same fields as createemails: contactlistid for one list, or contactlistids, segmentids, excludecontactlistids and excludesegmentids.
- Write
Schedule a campaign
Schedule a ready draft for a moment at least 15 minutes ahead (sendat as ISO 8601, timezone optional, defaults to the account time zone). The sending gate applies exactly as for sendemail; the first campaigns of every account pass a content review at send time.
- Write
Move a campaign to the trash
Reversible: the campaign leaves the list and can be restored with restorecampaign. Refused while it is sending.
- Write
Restore a campaign from the trash
Brings a trashed campaign back into the campaign list with its content, audience and results intact.
- Write
Start an A/B subject test
Starts an A/B subject-line test on a draft. A test slice of the audience (testpercentage: 10, 20 or 30) is split between subject A and subject B; after waithours (2, 4 or 24) the subject with more opens goes to everyone else.
- Write
Send a test copy of a campaign
Sends the campaign to 1 to 5 addresses as a test, exactly as the campaign page does: nothing is recorded against the campaign statistics and no contact list is touched. An optional note is shown as a banner above the body so reviewers know what to look at.
- Write
Copy a campaign into a new draft
Copies a campaign, including its subject, body, design, list, from address and file attachments, into a brand new draft. The copy starts clean: no send date, no statistics, no schedule and no A/B subject experiment, so it can be edited and sent on its own.
- Write
Change how a campaign is shared on the web
Controls the public side of a campaign: whether it has a web page at all (webversion on, off, or default to follow the account setting), whether it is listed in the account's public archive, and whether its public link is retired and replaced.
- Write
Attach a file to a draft campaign
Attaches one file to a campaign that is still a draft. The file is sent inline as base64 in contentbase64, so this is best for small files; filename must end in one of pdf, doc, docx, xls, xlsx, ppt, pptx, csv, txt, png, jpg, jpeg, gif, zip or ics.
- Destructive
Delete an unsent campaign permanently
Permanent, unlike trashcampaign. Only a campaign that has not been sent can be deleted; a sent campaign keeps its reports and can only be trashed. Use it to release a list that deletecontactlist refuses because a draft campaign still targets it.
- Destructive
Cancel a scheduled send
Cancels the scheduled send of a campaign; the draft stays and can be sent or rescheduled later.
- Destructive
Remove a file from a draft campaign
Permanently removes one attached file from a campaign that is still a draft. Pass the attachment id from getcampaign or from addcampaignattachment. The file is deleted, not archived, and the campaign's remaining attachments come back in the response.
Webhooks
- Write
Create a webhook endpoint
Creates an inbound webhook endpoint and returns its POST url. Any automation with a webhook trigger can start from it.
- Destructive
Delete a webhook endpoint
Deletes an endpoint; its url stops accepting requests. Refused while an automation starts from it.
Sending Identity
- Read
List sending domains
Lists the account's sending domains with a public verificationstatus (pendingrecords, checking, verified, failed), the DNS records to add as {type, host, value}, and the setup page url. A verified domain unlocks senders on its addresses.
- Read
Check a domain's DNS records
Asks Mailsoftly to check the DNS records of a domain. Verification can take time after DNS changes; listdomains shows the result later.
- Read
List reply-to addresses
Lists the reply-to addresses registered on the account and whether each is verified.
- Write
Add a sending domain
Starts domain authentication for a domain the account owns. Returns the DNS records (type, host, value) to add at the DNS host, then verifydomain checks them. Idempotent for an existing domain.
- Write
Create a sender address
Creates a from address on a verified domain (from, optional replyto and displayname). Without a verified domain the response carries the sending gate with the ways to unlock.
- Write
Add a reply-to address
Registers a reply-to address and emails it a one-click verification link. Idempotent; an unverified existing address gets the email again.
- Destructive
Archive a sending domain
Archives a domain. Refused while active senders still use it.
- Destructive
Remove a sender address
Deletes a never-used sender, or archives one that campaigns already used (history kept, address reserved). Connected mailboxes are managed in Settings.
Email Types
- Read
List email types
Lists the subscription categories (email types) contacts choose on the preference page, with the list each one feeds.
- Write
Create an email type
Creates a subscription category shown on the preference page; optionally linked to a contact list.
Compliance
- Read
Get the compliance summary for a region
Where this account stands against the email rules of one sending region, in a single call.
- Read
List consent evidence
The paper trail every regime asks a sender to keep: who consented, when, through which source, and where each address stands today.
- Read
List opt-out records
Every address that opted out of this account's mail, with the date it happened and how far the opt-out reaches.
- Read
Get the registry filing status
The filing figures for a national consent registry: how many contacts count as consent rows, how many opt-out rows exist, how many of those opt-outs have not been filed yet, how many contacts are marked as businesses, and when the consent and opt-out files were last produced.
- Write
Record a consent
Writes a dated consent row onto a contact's audit trail, for consent you collected somewhere else: your own signup form, a checkbox in your product, a sign-up sheet at an event.
Media
- Read
List hosted files
Lists the files this account has uploaded to its File Gallery, newest first. A campaign does not carry the file itself: it is hosted once and the campaign links to it, so every row carries the publicurl an email links to plus a publicviewurl for the branded viewer page.
- Read
List the image library
Lists the images this account has uploaded for its email and page editors, newest first, with the public URL campaign HTML uses as an image src. Each row carries the original filename, the title and the alt text, plus the folder it is filed in when it has one.
- Write
Upload a file to the gallery
Uploads one file to the File Gallery from base64 content and returns its public link, so a campaign can point at it. Send filename, contentbase64 and contenttype; the extension and the content type must both be on the accepted list, and the decoded size must stay under 25 MB.
- Write
Upload an image
Adds a PNG, JPG or GIF to the account image library from base64 content and returns a public URL ready to use as an image src.
- Destructive
Remove a file from the gallery
Takes a file out of the File Gallery and off the storage total. Links that were already sent keep resolving on purpose, so a delivered campaign does not turn into a dead link; the file simply stops appearing in the gallery and in listfiles. Pass fileid from listfiles.
Content Blocks
- Read
List saved content blocks
Lists the reusable HTML blocks saved in this account, most recently updated first. Each row carries the name, who saved it, whether it is shared with other accounts and a short plain text preview of its HTML. Fetch the full HTML of one block with getcustomblock.
- Read
Get one content block
Returns one saved block with its full HTML, so it can be pasted into a campaign body or edited and written back with updatecustomblock. Pass customblockid from listcustomblocks. A block that belongs to another account answers 404.
- Write
Save a content block
Saves a reusable HTML block (a footer, a header, a promo panel) under a name, so later campaigns can drop it in without rewriting it.
- Write
Update a content block
Changes the name, the HTML or the sharing of a saved block. Takes customblockid plus only the fields that change; anything left out keeps its current value. A block from another account answers 404.
- Destructive
Delete a content block
Deletes a saved block for good. Campaigns that already used the block keep the HTML they were built with, since the block is a starting point rather than a live include. Pass customblockid from listcustomblocks.
Brand Kit
- Read
Get the brand kit
Returns the account brand kit: the logo, the favicon, the colors, the palette, the site title and description and the social links, all of which campaigns and pages can reuse so they look like the company.
- Write
Update the brand kit
Sets brand fields by hand: logourl, primarycolor, secondarycolor, accentcolor, palette, sitetitle, sitedescription and sociallinks. Colors are six digit hex values such as 1A73E8 and URLs must be http or https; anything else answers 422 and nothing is written.
Domain Health
- Read
List saved domain health checks
Lists the domains this account has checked, newest check first. Takes no parameters and returns the SPF and DMARC readings, whether the domain shows up on public blocklists, when the check ran and who ran it.
- Write
Run a domain health check
Checks a domain the customer owns against public DNS and public blocklists, then saves the result on the account so listdomainhealthchecks can show it. Takes the domain as a hostname such as example.com; a pasted URL is trimmed down to the hostname.
No operations match.
See How connections work for access and permissions, or browse all integrations.
Reference date: October 27, 2026. Mailsoftly API docs.