Skip to main content
Mailcoach logo
  • Category: email newsletters
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 56
  • Triggers: 0
  • Slug: MAILCOACH
  • Version: 20261101_00

Tools

Slug: MAILCOACH_ADD_CAMPAIGNCreate a Mailcoach campaign for an email list or segment, optionally scheduling it for later sending.

Input Parameters

string
Raw HTML content for the campaign; if omitted, template_uuid or mailable_class must be provided
string
required
Unique name for the campaign
object
Dynamic template fields when using a template UUID.
boolean
Whether to automatically append UTM parameters to all links
string
Schedule date/time in ‘YYYY-MM-DD HH:MM:SS’ (server timezone)
string
UUID of the subscriber segment to target
string
UUID of the template; required if using a saved template
string
Fully-qualified class name for a custom mailable
boolean
Whether to disable the webview version of the email
string
required
UUID of the email list to send the campaign to
boolean
Whether to add subscriber-specific tags found in the content
Whether to add link tags for each subscriber

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_ADD_EMAIL_LISTTool to create a new email list. Use when you need to manage and organize subscribers before sending campaigns. Use after authentication.

Input Parameters

string
required
Email list name
string
Mailer for campaigns, as defined in the Laravel config
string
Mailer for automations, as defined in the Laravel config
string ("send_default_confirmation_mail" | "send_custom_confirmation_mail")
Type of confirmation mail to send
string
Default sender name
string
Comma-separated emails to receive reports
string
required
Default sender email address
boolean
Send report after each campaign is sent
string
Mailer for transactional emails, as defined in the Laravel config
string
Default reply-to name
boolean
Require double opt-in confirmation for new subscribers
boolean
Enable RSS feed for campaigns
string
Default reply-to email address
boolean
Include campaign summary in reports
boolean
Allow subscriptions via form
string
HTML content for custom confirmation mail; required if confirmation_mail is send_custom_confirmation_mail
string
Subject for custom confirmation mail; required if confirmation_mail is send_custom_confirmation_mail
string
URL redirect after a successful subscription
boolean
Include email list summary in reports
string
URL redirect after unsubscribed
array
Allowed tags that subscribers can choose when subscribing via form
string
URL redirect when already subscribed
string
URL redirect after subscription pending confirmation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_ADD_SUPPRESSIONTool to add a suppression entry. Use after detecting a bounce, spam complaint, or manual block.

Input Parameters

string
required
The email address to suppress
string ("hard_bounce" | "spam_complaint" | "manual")
Reason for suppression. One of ‘hard_bounce’, ‘spam_complaint’, or ‘manual’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_ADD_TAGTool to create a new tag within a specific email list. Use after confirming the email list exists.

Input Parameters

string
required
Name of the tag to create
string
required
UUID of the target email list where the tag will be created
boolean
Whether this tag should be shown in subscriber preference settings. If omitted, defaults to the server’s default behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_ADD_TAGS_TO_SUBSCRIBERAdd tags to a subscriber for segmentation and targeting. Tags are appended to existing tags. Use after obtaining a subscriber UUID from listing subscribers or creating a new subscription.

Input Parameters

array
required
List of tag names to add to the subscriber. Tags are appended to existing tags. Must contain at least one tag.
string
required
The UUID of the subscriber to add tags to. Obtain this from listing subscribers or subscribing a new user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_ADD_TRANSACTIONAL_EMAIL_TEMPLATECreates a new email template in Mailcoach via POST /api/templates. Use this action to create reusable HTML templates that can be referenced when sending transactional emails. Returns the created template with its UUID, which can be used to reference, update, or delete the template later.

Input Parameters

string
HTML content of the template. Supports Mailcoach placeholders like {{ subscriber.email }}. If neither html nor structured_html is provided, an empty string is used.
string
required
Name for the template. Used to identify the template in your Mailcoach account. Duplicate names are allowed (each template gets a unique UUID).
string
Structured HTML content, typically MJML format for responsive emails. Takes precedence over html if both provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_APPEND_TO_SUBSCRIBER_IMPORTTool to append CSV data to an existing subscriber import. Use after retrieving a subscriber import when additional subscriber data needs to be added.

Input Parameters

string
required
UUID of the subscriber import to append data to.
string
required
CSV formatted string of subscriber data to append.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_CONFIRM_SUBSCRIBERConfirm a subscriber’s subscription to an email list by subscriber UUID. On a successful confirmation response, returns a confirmation indicator and the subscriber UUID.

Input Parameters

string
required
The unique identifier (UUID) of the subscriber to confirm. This UUID is returned when creating a subscriber via the subscribe endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_CREATE_SEGMENTTool to create a new segment within an email list. Use when you need to target specific groups of subscribers based on tags.

Input Parameters

string
required
Name of the segment to create
array
List of tag names that should be excluded from the segment
array
List of tag names that should be included in the segment
string
required
UUID of the email list where the segment will be created
boolean
Whether all negative tags must be present for exclusion. If true, subscribers are excluded only if they have ALL negative tags. If false, subscribers are excluded if they have ANY negative tag.
boolean
Whether all positive tags must be present on a subscriber for inclusion. If true, subscribers must have ALL specified positive tags. If false, subscribers need only ONE of the positive tags.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_CREATE_SUBSCRIBER_IMPORTCreates a new subscriber import in Mailcoach. Use this to bulk import subscribers from CSV data into an email list. The import is created in ‘draft’ status and must be started separately using the start_subscriber_import action. The CSV must include a header row with at least an ‘email’ column. Optional columns include ‘first_name’, ‘last_name’, ‘tags’, and custom attributes. Requires a valid email_list_uuid from an existing email list.

Input Parameters

boolean
If true, all existing tags on the subscribers will be replaced with tags from the CSV. Defaults to false.
string
required
UUID of the target email list.
string
required
CSV string with subscribers’ data, one row per subscriber. Must include header.
boolean
If true, existing list members not present in the CSV will be unsubscribed. Use with caution. Defaults to false.
boolean
If true, previously unsubscribed emails will be resubscribed. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_CAMPAIGNTool to delete a campaign by UUID. Use when you need to permanently remove a campaign after confirming its identifier.

Input Parameters

string
required
The UUID of the campaign to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_EMAIL_LISTTool to delete an email list by UUID. Use when you need to permanently remove an email list after confirming its identifier.

Input Parameters

string
required
The UUID of the email list to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_SEGMENTTool to delete a segment from an email list. Use when you need to permanently remove a segment after confirming its identifiers.

Input Parameters

string
required
UUID of the segment to delete.
string
required
UUID of the email list containing the segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_SUBSCRIBERPermanently delete a subscriber by UUID from Mailcoach. Use this tool when you need to completely remove a subscriber and all their data. After deletion, the email address can be re-subscribed in the future. This action is irreversible - consider using unsubscribe instead if you want to preserve subscriber history.

Input Parameters

string
required
The unique identifier (UUID) of the subscriber to permanently delete. This can be obtained from the subscriber list or get subscriber endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_SUBSCRIBER_IMPORTTool to delete a subscriber import by its UUID. Use when you need to permanently remove a subscriber import after confirming its identifier.

Input Parameters

string
required
The UUID of the subscriber import to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_SUPPRESSIONTool to delete a suppression entry by UUID. Use when you need to permanently remove a suppression after confirming its identifier.

Input Parameters

string
required
The unique UUID of the suppression entry to delete. Obtain this from the ‘Get All Suppressions’ or ‘Add Suppression’ actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_TAGTool to delete a tag from an email list. Use when you need to permanently remove a tag after confirming its identifiers.

Input Parameters

string
required
UUID of the tag to delete.
string
required
UUID of the email list containing the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_TEMPLATETool to delete a template by UUID. Use when you need to permanently remove a template after confirming its UUID.

Input Parameters

string
required
The unique identifier (UUID) of the template to delete. Can be obtained from the Get All Templates or Get Specific Template actions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_DELETE_TRANSACTIONAL_MAILTool to delete a transactional mail send record by its UUID. This removes the logged send entry for a transactional email from the /api/sends endpoint. Use when you need to permanently remove a transactional mail log item. Note: This is idempotent - deleting a non-existent UUID returns success.

Input Parameters

string
required
UUID of the transactional mail send record to delete. This is the ‘uuid’ field from the sends list (GET /api/sends), not a template UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_ALL_CAMPAIGNSTool to retrieve all campaigns. Use when you need a paginated, sortable list of campaigns matching criteria.

Input Parameters

integer
Page number for paginated results.
string ("name" | "unique_open_count" | "unique_click_count" | "unsubscribe_rate" | "sent_to_number_of_subscribers" | "sent")
Sort field; prefix with ’-’ for descending. Allowed: name, unique_open_count, unique_click_count, unsubscribe_rate, sent_to_number_of_subscribers, sent.
Search term to find campaigns by name (e.g., ‘blackfriday’).
string ("sent" | "scheduled" | "draft")
Filter campaigns by status.
string
Filter by email list ID.
string
Filter by email list UUID.
string
Filter by associated template UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_ALL_SENT_ITEMSTool to retrieve all sent items. Use when you need to list and filter sent items after delivery.

Input Parameters

integer
Page number for pagination (must be ≥1)
string ("-sent_at" | "sent_at")
Sort by sent_at: ‘-sent_at’ for descending (default), ‘sent_at’ for ascending
string
Filter by campaign UUID
string
Filter by subscriber UUID
string
Filter by automation mail UUID
string
Filter by transactional mail log item UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_ALL_SUBSCRIBER_IMPORTSTool to retrieve all subscriber imports. Use when you need a paginated list of import jobs.

Input Parameters

integer
Page number for paginated results (must be ≥ 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_ALL_SUPPRESSIONSRetrieve a paginated list of all email suppression entries from Mailcoach. Suppressions are email addresses that will never receive emails. They can be created due to hard bounces, spam complaints, or manual blocking. Use this tool to: - View all suppressed email addresses - Search for specific suppressed emails - Filter by suppression reason (hard_bounce, spam_complaint, manual) - Get suppression UUIDs for use with get_specific_suppression or delete_suppression

Input Parameters

integer
Page number for paginated results
string
Sort by created_at; prefix with ’-’ for descending
string ("hard_bounce" | "spam_complaint" | "manual")
Filter suppressions by reason
string
Search by full or partial email address

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_ALL_TAGSTool to retrieve all tags for a specific email list. Use after confirming the email list exists.

Input Parameters

integer
Page number for paginated results
string
required
UUID of the email list to fetch tags for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_ALL_TEMPLATESTool to retrieve all templates. Use when you need a paginated list of templates with optional search and sorting.

Input Parameters

integer
Page number for paginated results (>= 1).
string ("name" | "updated_at" | "-name" | "-updated_at")
Sort field; prefix with ’-’ for descending. Allowed: ‘name’, ‘updated_at’.
string
Search term to filter templates by name (e.g., ‘welcome’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_ALL_TRANSACTIONAL_EMAIL_TEMPLATESTool to retrieve all transactional email templates. Use when you need a paginated list of transactional templates matching your criteria.

Input Parameters

integer
Page number for paginated results.
string ("created_at" | "-created_at")
Sort by created_at; prefix with ’-’ for descending (e.g., ‘-created_at’).
string
Filter templates by name (e.g., ‘welcome_email’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_CAMPAIGN_BOUNCESRetrieve a page of bounced subscribers for a sent campaign to track delivery issues. Filter by bounce type, search by email or name, and sort the results; pagination links help navigate additional pages.

Input Parameters

integer
Page number for pagination (default limit: 1000 items per page)
string
Sort results by created_at or email. Prefix with ’-’ for descending order (e.g., ‘-created_at’)
string
required
The UUID of the campaign to retrieve bounces for
string ("bounce" | "soft_bounce" | "complaint")
Enum for bounce types.
string
Search by email, first_name, or last_name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_CAMPAIGN_CLICKSTool to retrieve clicks from a sent campaign with pagination support. Use when you need to analyze link engagement and click-through data for a specific campaign.

Input Parameters

integer
Page number for pagination (default limit: 15 items per page)
string ("unique_click_count" | "-unique_click_count" | "click_count" | "-click_count")
Sort results by unique_click_count or click_count. Prefix with ’-’ for descending order (e.g., ‘-unique_click_count’).
string
required
The UUID of the campaign to retrieve clicks for
string
Search by URL (e.g., ‘example.com’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_CAMPAIGN_OPENSTool to retrieve all opens for a sent campaign with pagination support. Use when you need to see who opened a campaign and how many times.

Input Parameters

integer
Page number for paginated results (must be ≥1)
string ("email" | "-email" | "open_count" | "-open_count" | "first_opened_at" | "-first_opened_at")
Sort field; prefix with ’-’ for descending. Allowed: email, open_count, first_opened_at.
string
required
UUID of the campaign to retrieve opens for
string
Search by email address (e.g., ‘john@doe.com’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_CAMPAIGN_UNSUBSCRIBESRetrieve a page of unsubscribes from a sent campaign to see who unsubscribed. Search by email or name, sort by creation time, and use pagination links to navigate additional pages.

Input Parameters

integer
Page number for pagination (default limit is 1000)
string
Sort results by created_at; prefix with ’-’ for descending (e.g., ‘-created_at’)
string
required
The UUID of the campaign to get unsubscribes for
string
Search by email, first_name, or last_name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_EMAIL_LISTSTool to retrieve all email lists. Use when you need to fetch a paginated list of email lists with optional filters.

Input Parameters

integer
Page number for paginated results, must be >= 1
string ("name" | "-name" | "created_at" | "-created_at" | "active_subscribers_count" | "-active_subscribers_count")
Sort by one of ‘name’, ‘created_at’, or ‘active_subscribers_count’; prefix with ’-’ for descending
string
Exact match on list name
string
Fuzzy search by list name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_SEGMENTTool to retrieve details of a specific segment. Use when you need to fetch segment metadata after confirming the email list and segment UUIDs.

Input Parameters

string
required
UUID of the specific segment to retrieve. Obtain this from the ‘Get All Segments’ action.
string
required
UUID of the email list owning the segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_SPECIFIC_CAMPAIGNRetrieve details of a specific Mailcoach campaign by its UUID, including content, status, and campaign statistics.

Input Parameters

string
required
UUID of the campaign to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_SPECIFIC_EMAIL_LISTRetrieve detailed information about a specific Mailcoach email list by its UUID. Returns comprehensive list details including: - Basic info: name, UUID, subscriber count - Email settings: default from/reply-to addresses and names - Subscription settings: form subscriptions, confirmation requirements, redirect URLs - Mailer configurations: campaign, automation, and transactional mailers - Reporting settings: report recipients and enabled report types - Timestamps: creation and last update dates Use this action when you need complete details about a specific email list. The UUID can be obtained from the Get Email Lists action.

Input Parameters

string
required
The UUID of the email list to retrieve. Can be obtained from the Get Email Lists action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_SPECIFIC_SUBSCRIBERTool to retrieve a specific subscriber. Use when you need to fetch subscriber details by UUID.

Input Parameters

string
required
The UUID of the subscriber to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_SPECIFIC_SUPPRESSIONTool to retrieve a specific suppression entry. Use when you need to fetch suppression details by UUID or email.

Input Parameters

string
required
The UUID or email identifier of the suppression entry to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_SPECIFIC_TAGTool to retrieve details of a specific tag. Use when you need to fetch tag metadata after confirming the email list and tag UUIDs.

Input Parameters

string
required
UUID of the specific tag to retrieve. Obtain this from the ‘Get All Tags’ action.
string
required
UUID of the email list owning the tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_SPECIFIC_TEMPLATERetrieves the full details of a specific Mailcoach email template by its UUID. Use this to fetch template content (HTML), metadata, and timestamps for a known template. The UUID can be obtained from the ‘Get All Templates’ action or from template creation responses. Returns template name, HTML content, structured HTML (if present), and timestamps.

Input Parameters

string
required
The unique identifier (UUID) of the template to retrieve. Obtain this from the ‘Get All Templates’ action or after creating a template.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_SUBSCRIBER_IMPORTTool to retrieve details of a specific subscriber import by UUID. Use when you need to check the status or details of a particular import job.

Input Parameters

string
required
The UUID of the subscriber import to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_TRANSACTIONAL_MAILRetrieves a specific transactional email by UUID, including its subject, HTML content, and recipients.

Input Parameters

string
required
The unique identifier (UUID) of the transactional email to retrieve. Obtain this from the ‘Get Transactional Mails’ action or after sending a transactional email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_GET_USERTool to retrieve details of the currently authenticated user. Use when you need to get information about the user associated with the API token.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_LIST_SEGMENTSRetrieve a page of segments for a specific email list, including tag-based subscriber criteria. Use the page parameter and pagination metadata to navigate results.

Input Parameters

integer
Page number for paginated results
string
required
UUID of the email list to fetch segments for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_LIST_SUBSCRIBERSTool to list all subscribers from a specific email list with pagination support. Use when you need to fetch subscribers from an email list, with optional filtering by email, search terms, or subscription status.

Input Parameters

integer
Page number for paginated results, must be >= 1
string ("created_at" | "-created_at" | "updated_at" | "-updated_at" | "subscribed_at" | "-subscribed_at" | "unsubscribed_at" | "-unsubscribed_at" | "email" | "-email" | "first_name" | "-first_name" | "last_name" | "-last_name")
Sort by field; prefix with ’-’ for descending order
integer
Number of results per page (1-100), default is 15
string
Filter by exact email address match
string
Fuzzy search across email, first_name, last_name, and tags
string ("unconfirmed" | "subscribed" | "unsubscribed")
Filter by subscriber status: unconfirmed, subscribed, or unsubscribed
string
required
UUID of the email list to retrieve subscribers from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_LIST_TRANSACTIONAL_MAILSTool to retrieve all transactional email records. Use when you need a paginated list of sent transactional mails.

Input Parameters

integer
Page number for paginated results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_REMOVE_TAGS_FROM_SUBSCRIBERTool to remove tags from a subscriber. Use after retrieving a subscriber’s UUID to adjust their segments.

Input Parameters

array
required
Non-empty list of tag names to remove from the subscriber.
string
required
The UUID of the subscriber from whom tags will be removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_RESEND_CONFIRMATIONTool to resend confirmation email to a subscriber. Use when a subscriber hasn’t confirmed and you need to resend the confirmation.

Input Parameters

string
required
The UUID of the subscriber to resend the confirmation email to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_START_SUBSCRIBER_IMPORTStarts processing a draft subscriber import by UUID, adding or updating subscribers from its CSV data. On HTTP 204, returns a structured success result with the status code and available rate-limit information.

Input Parameters

string
required
UUID of the subscriber import to start. The import must be in ‘draft’ status. Use ‘Get All Subscriber Imports’ or ‘Create Subscriber Import’ to obtain a valid UUID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_SUBSCRIBE_TO_EMAIL_LISTSubscribe (or update) a subscriber to an email list. By default, this upserts: if the email already exists in the list, it updates the subscriber; otherwise, it creates a new one. Use strict=true to prevent updates and fail if the email already exists. Tags are synced/replaced when provided. Use skip_confirmation=true to bypass double opt-in.

Input Parameters

array
Tags to set; passing tags will sync/replace tags on the subscriber (optional)
string
required
Subscriber’s email address (must use a real domain; test domains like example.com are rejected by the API)
boolean
If true and the email already exists, the call fails instead of updating (optional)
string
Subscriber’s last name (optional)
string
Subscriber’s first name (optional)
string
required
UUID of the email list to add the subscriber to
object
Custom fields as key-value pairs (optional, values must be strings)
boolean
Skip double opt-in; immediately confirm the subscription (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_UNSUBSCRIBE_SUBSCRIBERUnsubscribe a subscriber from their email list in Mailcoach. This changes the subscriber’s status to ‘unsubscribed’ without deleting them. Use when a user requests to stop receiving emails. The subscriber can be resubscribed later if needed. Requires the subscriber’s UUID (obtained from subscribe or get subscriber actions).

Input Parameters

string
required
The unique identifier (UUID) of the subscriber to unsubscribe. Obtain this from MAILCOACH_SUBSCRIBE_TO_EMAIL_LIST or MAILCOACH_GET_SPECIFIC_SUBSCRIBER.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_UPDATE_CAMPAIGNTool to update an existing Mailcoach campaign. Use after identifying the campaign UUID when you need to modify campaign attributes such as name, schedule, or content.

Input Parameters

string
Raw HTML content of the campaign
string
required
New name for the campaign
string
required
UUID of the campaign to update
object
Key-value pairs to merge into dynamic template fields
string
Markdown content if using a markdown-enabled template
string
Override email subject line
boolean
Append UTM tags to all links
string
Override ‘from’ display name
string
Override ‘from’ email address
string
Scheduled send datetime in ‘YYYY-MM-DD HH:MM:SS’ (server timezone)
string
UUID of a subscriber segment to target
string
UUID of the template to use; omit to keep current template
string
Fully-qualified class name for a custom mailable
boolean
Disable public webview generation
string
required
UUID of the email list to send the campaign to
boolean
Tag subscribers after send
Tag clicked links per subscriber

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_UPDATE_EMAIL_LISTTool to update an existing email list. Use when you need to modify a list’s configuration after verifying its UUID.

Input Parameters

string
required
Email list name
string
required
The UUID of the email list to update
string
Mailer for campaigns, as defined in the Laravel config
string
Mailer for automations, as defined in the Laravel config
string ("send_default_confirmation_mail" | "send_custom_confirmation_mail")
Type of confirmation mail to send
string
Default sender name
string
Comma-separated emails to receive reports
string
required
Default sender email address
boolean
Send report after each campaign is sent
string
Mailer for transactional emails, as defined in the Laravel config
string
Default reply-to name
boolean
Require double opt-in confirmation for new subscribers
boolean
Enable RSS feed for campaigns
string
Default reply-to email address
boolean
Include campaign summary in reports
boolean
Allow subscriptions via form
string
HTML content for custom confirmation mail; required if confirmation_mail is ‘send_custom_confirmation_mail’
string
Subject for custom confirmation mail; required if confirmation_mail is ‘send_custom_confirmation_mail’
string
URL redirect after a successful subscription
boolean
Include email list summary in reports
string
URL redirect after unsubscribed
array
Allowed tags that subscribers can choose when subscribing via form
string
URL redirect when already subscribed
string
URL redirect after subscription pending confirmation

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_UPDATE_SEGMENTTool to update an existing segment within an email list. Use when you need to modify segment criteria, name, or tag rules after verifying its existence.

Input Parameters

string
required
Name of the segment
string
required
UUID of the segment to update
array
List of tag names that subscribers should NOT have to be included in this segment
array
List of tag names that subscribers should have to be included in this segment
string
required
UUID of the email list containing the segment
boolean
Whether all negative tags must be excluded from a subscriber to be included in the segment
boolean
Whether all positive tags must be present on a subscriber to be included in the segment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_UPDATE_SUBSCRIBERTool to update a subscriber. Use when you need to modify subscriber details after creation.

Input Parameters

array
Tags to set; replaces existing tags by default.
string
required
The subscriber’s email address.
string
Subscriber’s last name. Set to null to remove.
string
Subscriber’s first name. Set to null to remove.
boolean
If true, provided tags are appended instead of replaced.
string
required
UUID of the subscriber to update.
object
Additional custom attributes for the subscriber.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_UPDATE_SUBSCRIBER_IMPORTUpdates a draft subscriber import with CSV data and a target email list. The request also sets the resubscription, unsubscribe-others, and replace-tags options; omitted options are sent as false.

Input Parameters

string
required
UUID of the subscriber import to update. Must be an existing import in ‘draft’ status.
boolean
If true, all existing tags on subscribers will be replaced with tags from the CSV. Defaults to false.
string
required
UUID of the target email list where subscribers will be imported.
string
required
CSV string with subscribers’ data. Must include a header row with at least an ‘email’ column. Optional columns: ‘first_name’, ‘last_name’, ‘tags’, and custom attributes.
boolean
If true, existing list members not present in the CSV will be unsubscribed. Use with caution. Defaults to false.
boolean
If true, previously unsubscribed emails will be resubscribed. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_UPDATE_TAGUpdates a tag within an email list. A tag name is required and preference visibility can also be specified.

Input Parameters

string
required
New name for the tag
string
required
UUID of the tag to update
string
required
UUID of the email list containing the tag
boolean
Whether this tag should be shown in subscriber preference settings

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAILCOACH_UPDATE_TEMPLATEUpdates an existing email template in Mailcoach. Use this to modify a template’s name, HTML content, or structured HTML. The template UUID is required - get it from the Get All Templates action. Only the name is required; other fields are optional. Returns the updated template with its ID, content, and timestamps.

Input Parameters

string
The template’s new HTML content. Supports Mailcoach placeholders like {{ subscriber.first_name }}. If not provided, existing HTML content is preserved.
string
required
The template’s new name (required). Use a descriptive name like ‘Welcome Email’ or ‘Monthly Newsletter’.
string
required
UUID of the template to update. Get template UUIDs using the Get All Templates action.
string
Structured HTML content (e.g., MJML format) for visual email builders. Set to null to clear, omit to preserve existing value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not