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

Tools

Slug: MOOSEND_ADD_SEGMENT_CRITERIATool to add a new criterion (rule) to a segment. Use after obtaining the mailing list ID and segment ID to define filtering criteria.

Input Parameters

string
required
The field of the criterion to filter the mailing list by (e.g., ‘Email’, ‘Name’, custom field name).
string
required
A search term to filter the specified field by.
string
Response format. Only ‘json’ is supported.
string
Provides an additional filter option to be combined with date-related fields.
string
An operator that defines the way to compare a criterion field with its value (e.g., ‘Is’, ‘IsNot’, ‘Contains’).
string
Provides an additional filter option to be combined with date-related fields.
string
required
The ID of the segment to add the criterion to.
string
required
The ID of the mailing list the specified segment belongs 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: MOOSEND_ADD_SUBSCRIBERTool to add or update a subscriber in a mailing list. Use after obtaining the mailing list ID to manage subscribers.

Input Parameters

string
Display name of the subscriber.
array
Tags to apply to the subscriber.
string
required
Email address of the subscriber.
string
Response format.
array
Preference values for the subscriber.
array
List of custom field values in ‘FieldName=Value’ format.
string
required
The unique identifier of the mailing list to add the subscriber to.
boolean
Flag indicating external double opt-in consent.

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: MOOSEND_BULK_SUBSCRIBEAdd or update up to 1000 subscribers in one Moosend mailing-list request.

Input Parameters

array
required
One to 1000 subscribers to add or update.
string
required
ID of the destination mailing list.
boolean
Whether consent was collected outside Moosend.

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: MOOSEND_CLONE_CAMPAIGNTool to clone an existing campaign, creating an exact copy with the same content and settings. Use when you want to reuse a campaign template or create variations of an existing campaign. The cloned campaign is created as a new draft that can be modified independently.

Input Parameters

string ("json" | "xml")
Response format. Use ‘json’ (default) for JSON responses or ‘xml’ for XML responses.
string
required
The unique identifier (UUID format) of the campaign to clone. The cloned campaign will be created as a new draft with the same content and settings as the original.

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: MOOSEND_CREATE_CUSTOM_FIELDTool to create a custom field in a mailing list. Use when you need to define a new custom field for subscriber data.

Input Parameters

string
required
The name of the custom field.
string ("json" | "xml")
The response format. Use ‘json’ for JSON responses and ‘xml’ for XML responses.
string
Comma-separated options for a SingleSelectDropdown field.
boolean
Whether the custom field is hidden from subscribers on the update profile page.
boolean
Whether the custom field is mandatory when adding a subscriber.
string
required
The ID of the mailing list where the custom field will be created.
string ("Text" | "Number" | "DateTime" | "SingleSelectDropdown" | "CheckBox")
The data type of the custom field.

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: MOOSEND_CREATE_MAILING_LISTTool to create a new empty mailing list in Moosend. Use after obtaining API key.

Input Parameters

string
required
Name of the mailing list.
string
URL displayed after subscription confirmation.
string
URL users are redirected to after unsubscribing.

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: MOOSEND_CREATE_SEGMENTTool to create a new segment for a mailing list. Use to organize subscribers based on criteria or create empty segments for future use.

Input Parameters

string
required
The name of the segment.
string ("json" | "xml")
Response format. Use ‘json’ (recommended and default) or ‘xml’.
array
Array of filter criteria. Leave empty to create a segment without criteria.
string ("All" | "Top" | "TopPercent")
How many matching subscribers to fetch.
string ("All" | "Any")
How segment criteria match together.
integer
Value for FetchType ‘Top’ or ‘TopPercent’ (e.g., 100 for top 100 subscribers, or 10 for top 10%).
string
required
The ID of the mailing list to create the segment in.

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: MOOSEND_DELETE_CAMPAIGNPermanently deletes a campaign from your Moosend account by its ID. This action removes draft or sent campaigns irreversibly. Use this when you need to clean up campaigns that are no longer needed. The campaign ID can be obtained from listing campaigns or retrieved when a campaign is created. Always verify the campaign ID before deletion as this operation cannot be undone.

Input Parameters

string ("json" | "xml")
Response format. Use ‘json’ (default) for JSON responses or ‘xml’ for XML responses.
string
required
The unique identifier (UUID format) of the campaign to delete. This can be a draft or sent campaign. Deletion is permanent and irreversible.

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: MOOSEND_DELETE_CUSTOM_FIELDTool to remove a custom field definition from a mailing list. Use when you have confirmed the custom field ID to delete.

Input Parameters

string ("json" | "xml")
The response format. Use ‘json’ for JSON responses and ‘xml’ for XML responses.
string
required
The ID of the custom field to delete.
string
required
The ID of the mailing list containing the custom field 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: MOOSEND_DELETE_MAILING_LISTTool to delete a mailing list. Use when you need to permanently remove a mailing list from your Moosend account after confirming its ID. Deletion is irreversible.

Input Parameters

string
Response format, either ‘json’ or ‘xml’.
string
required
The ID of the mailing 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: MOOSEND_GET_ALL_CAMPAIGNSRetrieves a page of campaigns in your account. Specify a page to explore campaign data; the default is page 1.

Input Parameters

integer
Page number of campaign results to retrieve. Defaults to 1.
string
Response format. Only ‘json’ is supported.

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: MOOSEND_GET_ALL_SUBSCRIBERSRetrieves all subscribers from a specified mailing list, filtered by their subscription status (Subscribed, Unsubscribed, Bounced, or Removed). Returns paginated results with subscriber details including email, name, custom fields, and subscription timestamps.

Input Parameters

integer
Page number of subscriber results to retrieve. Use this with page_size to paginate through large lists.
string
Response format.
string ("Subscribed" | "Unsubscribed" | "Bounced" | "Removed")
The subscription status to filter by. ‘Subscribed’ returns active subscribers, ‘Unsubscribed’ returns those who opted out, ‘Bounced’ returns email addresses that bounced, ‘Removed’ returns manually removed subscribers.
integer
Number of subscriber records to return per page. Maximum recommended is 500.
string
required
The ID of the mailing list containing the subscribers.

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: MOOSEND_GET_CAMPAIGN_DETAILSRetrieves comprehensive details about a specific campaign by its ID. Returns complete campaign information including configuration, status, content, and settings. Use this when you need to inspect or verify campaign properties.

Input Parameters

string
required
The unique identifier of the campaign whose details are to be retrieved.

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: MOOSEND_GET_CAMPAIGN_ENGAGEMENT_REPORTReturn one page of recipient-level campaign open or link-click activity.

Input Parameters

integer
Page number to return.
string
Inclusive end date in DD-MM-YYYY format.
string
Inclusive start date in DD-MM-YYYY format.
integer
Number of records per page, from 1 through 1000.
string
required
ID of the campaign to report on.
string ("Opened" | "LinkClicked")
required
Engagement activity to return: campaign opens or link clicks.

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: MOOSEND_GET_CAMPAIGN_STATS_BY_LOCATIONRetrieves a detailed report of campaign opens (unique and total) by country. Use this when you need to analyze the geographic distribution of email campaign engagement.

Input Parameters

string
required
The unique identifier of the campaign to retrieve location statistics 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: MOOSEND_GET_MAILING_LIST_DETAILSGets details for a given mailing list including name, member counts, status, and custom field definitions. Optionally include subscriber statistics. Use this when you need to inspect mailing list properties or verify list configuration.

Input Parameters

string ("json" | "xml")
Response format: ‘json’ or ‘xml’.
string
required
The ID of the mailing list to be returned.
string ("true" | "false")
Whether to include statistics in the response.

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: MOOSEND_GET_SUBSCRIBER_BY_EMAILRetrieves detailed subscriber information by email address from a specific mailing list. Returns comprehensive subscriber data including ID, name, subscription status, custom fields, tags, preferences, and timestamps for creation, updates, and unsubscribe events. Use this when you need to: - Look up a subscriber’s details using their email address - Check if an email is already subscribed to a list - Retrieve custom field values for a subscriber - Check subscription status and history Example: “Get subscriber details for jane.doe@example.com in list 04fad8e2-…”

Input Parameters

string
required
Email address of the subscriber to retrieve.
string
Response format (must be ‘json’).
string
required
The ID of the mailing list to search in.

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: MOOSEND_LIST_ALL_MAILING_LISTSRetrieves a page of mailing lists in your account, with optional statistics and sorting. Specify the page and page size to explore further results.

Input Parameters

integer
The page number to display results for. Must be a positive integer.
string
Response format. Only JSON format is supported.
string ("Name" | "Subject" | "Status" | "DeliveredOn" | "CreatedOn")
Sort by property for mailing lists.
integer
The maximum number of results per page. Must be a positive integer.
string ("ASC" | "DESC")
Sort method for mailing lists.
string
Whether to fetch statistics for subscribers. Use ‘true’ or ‘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: MOOSEND_LIST_ALL_SENDERSTool to retrieve a list of all active senders in your account. Use when you need to view available sender email addresses for campaigns.

Input Parameters

string ("json" | "xml")
Response format. Use ‘json’ for JSON responses and ‘xml’ for XML responses.

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: MOOSEND_LIST_CAMPAIGNS_WITH_PAGINGTool to retrieve a paginated list of all campaigns in your account with detailed information. Use when you need to fetch campaigns with specific page size and sorting options. Paging information is required as input.

Input Parameters

integer
required
The page number to display results for. Must be a positive integer.
string ("Name" | "Subject" | "Status" | "DeliveredOn" | "CreatedOn")
Sort field options for campaigns.
integer
required
The maximum number of results per page. Must be a positive integer up to 100. If a value greater than 100 is specified, it will be treated as 100.
string ("ASC" | "DESC")
Sort method options.

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: MOOSEND_LIST_SEGMENTSTool to get a list of all segments with their criteria for a specified mailing list. Use when you need to retrieve segment definitions for targeting specific subscriber groups.

Input Parameters

string
Response format. Only ‘json’ is supported.
string
required
The ID of the mailing list to retrieve 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: MOOSEND_REMOVE_MULTIPLE_SUBSCRIBERSTool to permanently remove multiple subscribers from a mailing list. Use when you need to delete multiple subscribers permanently without adding them to the suppression list. Invalid email addresses are automatically ignored.

Input Parameters

string
required
Comma-separated string of email addresses to remove from the mailing list. Invalid email addresses will be ignored.
string
Response format. Only ‘json’ is supported.
string
required
The ID of the mailing list to remove the 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: MOOSEND_REMOVE_SUBSCRIBERPermanently remove one subscriber without suppressing the email address.

Input Parameters

string
required
Email address of the subscriber to remove.
string
required
ID of the mailing list containing 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: MOOSEND_SCHEDULE_CAMPAIGNRequest scheduling of a Moosend campaign by ID for a specified delivery date and time, with an optional time zone.

Input Parameters

string
Response format. Always ‘json’.
string
Time zone for the scheduled date and time in IANA format (e.g., ‘Europe/London’). Defaults to UTC if omitted.
string
required
The ID of the campaign to schedule.
string
required
Scheduled date and time for delivery in ‘yyyy-MM-dd HH:mm:ss’ format (e.g., ‘2026-12-31 10:00:00’).

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: MOOSEND_SEND_CAMPAIGNTool to send an existing draft campaign immediately. Use when you want to dispatch a campaign to all recipients after final review.

Input Parameters

string
Response format. Only ‘json’ is supported.
string
required
The unique identifier of the draft campaign to send.

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: MOOSEND_UNSCHEDULE_CAMPAIGNTool to unschedule a campaign. Removes a previously defined scheduled date and time from a campaign, so that it will be delivered immediately if already queued or when sent.

Input Parameters

string ("json" | "xml")
Response format. Use ‘json’ (default and recommended) or ‘xml’. Note: Only JSON format is fully supported; XML responses are not parsed by this action.
string
required
The ID of the campaign to unschedule.

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: MOOSEND_UNSUBSCRIBE_FROM_ACCOUNTTool to unsubscribe a subscriber from the account. Use when you need to remove a subscriber from all mailing lists. Note: Rate limit is 20 requests per 10 seconds per API key.

Input Parameters

string
required
The email address of the subscriber to unsubscribe from the account.
string ("json" | "xml")
Response format. Use ‘json’ (recommended and default) or ‘xml’. Note: XML responses require additional parsing.

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: MOOSEND_UNSUBSCRIBE_FROM_MAILING_LISTTool to unsubscribe a subscriber from a specified mailing list. Use when you need to remove a subscriber’s active subscription. Rate limit: 20 requests per 10 seconds per API key.

Input Parameters

string
required
Email address of the subscriber to unsubscribe.
string
Response format. Only JSON is supported.
string
required
The unique identifier of the mailing list to unsubscribe 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: MOOSEND_UPDATE_CAMPAIGNTool to update a draft campaign. Use when you want to modify properties of an existing draft campaign before sending.

Input Parameters

boolean
Flag to indicate an A/B split campaign.
string
required
New name of the campaign.
string ("json" | "xml")
Response format: ‘json’ or ‘xml’.
string
Subject line of the campaign.
string
Second subject line for A/B tests.
string
required
ID of the draft campaign to update.
integer
Number of hours to run A/B test (1-24).
string
Sender email address for the campaign.
string
URL to fetch campaign HTML content; CSS will be inlined.
string
HTML content for version B of the campaign.
array
List of mailing lists and optional segments to send the campaign to.
string
Reply-to email address for the campaign.
string
Sender email for version B of the campaign.
string
Web location for version B of the campaign.
string ("Subjectline" | "Content" | "Sender")
Type of A/B test: Subjectline, Content, or Sender.
integer
Percentage of list to use for A/B testing (5-40).
string
Email address to receive send confirmations.
string ("OpenRate" | "TotalUniqueClicks")
Metric to choose A/B winner: OpenRate or TotalUniqueClicks.
boolean
Enable Google Analytics tracking if configured.

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: MOOSEND_UPDATE_CUSTOM_FIELDUpdates a custom field in a mailing list by list and field ID. The name is required, and the required and hidden flags are sent as false unless specified.

Input Parameters

string
required
The new name for the custom field.
string ("json" | "xml")
The response format. Use ‘json’ for JSON responses and ‘xml’ for XML responses.
string
Comma-separated options for ‘SingleSelectDropdown’; required if custom_field_type is ‘SingleSelectDropdown’.
boolean
Whether the custom field is hidden from subscribers on the update profile page.
boolean
Whether the custom field is mandatory when adding a subscriber.
string
required
The ID of the custom field to update.
string
required
The ID of the mailing list containing the custom field.
string ("Text" | "Number" | "DateTime" | "SingleSelectDropdown" | "CheckBox")
Specifies the data type of the custom field; one of ‘Text’, ‘Number’, ‘DateTime’, ‘SingleSelectDropdown’, ‘CheckBox’.

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: MOOSEND_UPDATE_MAILING_LISTTool to update the properties of an existing mailing list. Use when you need to change list metadata after confirming the list ID.

Input Parameters

string
New name for the mailing list.
string
Response format, either ‘json’ or ‘xml’.
string
A description for the mailing list.
string
Sender name for the mailing list.
string
Sender email address for the mailing list.
string
Reply-to email address for the mailing list.
string
required
The unique identifier of the mailing list to update.

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: MOOSEND_UPDATE_SEGMENTTool to update properties and criteria of an existing segment. Use when you need to modify segment name, match type, or filtering criteria.

Input Parameters

string
The new name for the segment. If not provided, the existing name is retained.
string ("json" | "xml")
Response format. Use ‘json’ (recommended and default) or ‘xml’.
array
Array of filter criteria for the segment. If provided, existing criteria will be replaced. If not provided, existing criteria are retained.
string ("All" | "Top" | "TopPercent")
How many matching subscribers to fetch.
string ("All" | "Any")
How segment criteria match together.
integer
Value for FetchType ‘Top’ or ‘TopPercent’ (e.g., 100 for top 100 subscribers, or 10 for top 10%). Required when FetchType is ‘Top’ or ‘TopPercent’.
string
required
The ID of the segment to update.
string
required
The ID of the mailing list the segment belongs 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: MOOSEND_UPDATE_SEGMENT_CRITERIATool to update an existing criterion in a segment. Use when you need to modify filtering rules for a mailing list segment.

Input Parameters

string
required
The field of the criterion to filter the mailing list by (e.g., ‘Email’, ‘Name’, custom field names).
string
required
A search term to filter the specified field by.
string ("json" | "xml")
Response format. Use ‘json’ (recommended and default) or ‘xml’. Note: XML responses require additional parsing.
string
Provides an additional filter option to be combined with date-based fields. Format: ISO 8601 date string.
string
An operator that defines the way to compare a criterion field with its value (e.g., ‘Is’, ‘IsNot’, ‘Contains’, ‘NotContains’, ‘StartsWith’, ‘EndsWith’).
string
Provides an additional filter option to be combined with date-based fields. Format: ISO 8601 date string.
string
required
The ID of the segment containing the criterion to update.
integer
required
The ID of the criterion to update.
string
required
The ID of the mailing list the specified segment belongs 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: MOOSEND_UPDATE_SUBSCRIBERTool to update a subscriber in the specified mailing list. Use when you need to modify subscriber information like email, name, or custom fields.

Input Parameters

string
The name of the member
string
required
The email address of the member
string ("json" | "xml")
Response format. Use ‘json’ (recommended and default) or ‘xml’. Note: XML responses require additional parsing.
array
List of custom field values in ‘FieldName=Value’ format, matching the member’s custom fields
string
required
The id of the subscriber to be updated
string
required
The ID of the mailing list that contains the subscriber
boolean
Flags the member as having given subscription consent by other means

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