Enginemailer

Learn how to use Enginemailer with Composio

Overview

SLUG: ENGINEMAILER

Description

Enginemailer is an email marketing platform that enables businesses to manage contacts, design campaigns, and send personalized emails.

Authentication Details

generic_api_key
stringRequired

Connecting to Enginemailer

Create an auth config

Use the dashboard to create an auth config for the Enginemailer toolkit. This allows you to connect multiple Enginemailer accounts to Composio for agents to use.

1

Select App

Navigate to Enginemailer.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Enginemailer Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4enginemailer_auth_config_id = "ac_YOUR_ENGINEMAILER_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Enginemailer for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, enginemailer_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Enginemailer toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Activate Subscriber

Description

Tool to activate an inactive subscriber in EngineMailer. Use when you need to reactivate a subscriber that was previously deactivated either through the API or manually.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add or Update Subscriber

Description

Tool to add or update a subscriber with custom fields via N8N integration. Use when you need to create a new subscriber or update an existing one in the EngineMailer system.

Action Parameters

customFields
object
email
stringRequired
firstName
string
lastName
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check Batch Update Status

Description

Tool to check the status of a batch subscriber update operation. Use when you need to verify if a batch update job has completed or is still processing.

Action Parameters

ID
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Batch Update Subscribers

Description

Tool to add or update multiple subscribers with custom fields in a single batch operation. Use when you need to create or update multiple subscribers efficiently. Subscribers that fail validation are removed from processing automatically.

Action Parameters

subscribers
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check Export Status V2

Description

Tool to check status of a previously requested CSV report export. Use after initiating an export to poll for completion.

Action Parameters

ID
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Test API Connection

Description

Tool to test API connection and verify authentication. Use when you need to validate API credentials or check connectivity.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Campaign

Description

Tool to create a new email campaign. Use when you need to configure and schedule a campaign before sending.

Action Parameters

attachments
array
campaignContent
stringRequired
campaignName
stringRequired
campaignSubject
stringRequired
campaignText
string
fromEmail
stringRequired
fromName
stringRequired
replyTo
string
sendDate
stringRequired
toListID
integerRequired
trackClicks
boolean
trackOpens
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Campaign

Description

Tool to delete an undelivered email campaign. Use when you need to remove a campaign that has not been sent yet.

Action Parameters

CampaignID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Recipient List

Description

Tool to delete an existing recipient list from a targeted campaign. Use when you need to remove a specific recipient list from a campaign.

Action Parameters

campaignid
stringRequired
recipientlistid
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Subscriber

Description

Tool to remove a subscriber from the system by email address. Use when you need to permanently delete a subscriber's record.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Export CSV Report V2

Description

Tool to export a transactional email report as CSV. Use when you need to initiate an export within a specific date range (max past 60 days).

Action Parameters

DomainFilter
string
EmailToFilter
string
Period
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Find Subscriber

Description

Tool to find a subscriber by email address via N8N integration. Use when you need to search for and retrieve subscriber information from the EngineMailer system.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Check Export Status V2

Description

Tool to check the status of a delivery report export. Use when you need to verify if an export job has completed and retrieve the download URL.

Action Parameters

ID
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Custom Field List

Description

Tool to retrieve the list of custom fields configured for subscribers. Use when you need to discover available custom fields for subscriber management.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get List Campaign

Description

Tool to get a list of undelivered campaigns. Use when you need to fetch campaigns awaiting delivery.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get New Subscribers

Description

Tool to retrieve new subscribers with optional filtering by source, form, page, or popup. Use when you need to fetch recently added subscribers for synchronization or reporting workflows.

Action Parameters

filter_form
integer
filter_page
integer
filter_popup
integer
lastpollingdate
string
limit
integerDefaults to 50
source
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Subcategories

Description

Tool to retrieve subcategories for a given category. Use when you need to list or choose subcategories after selecting a category.

Action Parameters

CategoryID
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Subscriber

Description

Tool to retrieve subscriber information by email address. Use when you need to fetch details about a specific subscriber including their custom fields.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Subscriber Autoresponder Completed

Description

Tool to retrieve subscribers who completed autoresponders with optional filtering by autoresponder ID. Use when you need to fetch completion events for autoresponders, optionally filtered by specific autoresponder or polling for new events since a timestamp.

Action Parameters

filter_autoresponder
integer
lastpollingdate
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Subscriber Autoresponder Triggered

Description

Tool to retrieve subscribers who triggered autoresponders with optional filtering by autoresponder ID. Use when you need to fetch trigger events for autoresponders, optionally filtered by specific autoresponder or polling for new events since a timestamp.

Action Parameters

filter_autoresponder
integer
lastpollingdate
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Deleted Subscribers

Description

Tool to retrieve deleted subscribers since last polling date. Use when you need to track or sync subscribers who have been removed from the system.

Action Parameters

lastpollingdate
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Subscribers Modified

Description

Tool to retrieve modified subscribers since last polling date with optional limit. Use when you need to fetch recently modified subscribers for synchronization or polling workflows.

Action Parameters

lastpollingdate
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Subscribers Tagged

Description

Tool to retrieve subscribers who were tagged with optional filtering by subcategory. Use when you need to fetch tagged subscribers for synchronization or reporting workflows.

Action Parameters

filter_subcategory
integer
lastpollingdate
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Untagged Subscribers

Description

Tool to retrieve subscribers who were untagged from subcategories. Use when you need to track or sync subscribers who have had tags removed, with optional filtering by subcategory and polling date.

Action Parameters

filter_subcategory
integer
lastpollingdate
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Unsubscribe Events

Description

Tool to retrieve unsubscribe events with optional filtering by campaign or autoresponder. Use when you need to fetch unsubscribe data for reporting, synchronization, or compliance workflows.

Action Parameters

filter
string
filter_autoresponder
integer
filter_campaign
integer
lastpollingdate
string
limit
integerDefaults to 50

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Insert Subscriber

Description

Tool to add a new subscriber with optional custom fields. Use when registering a user to a specific mailing list after verifying their email.

Action Parameters

customfields
object
email
stringRequired
listid
integerRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Autoresponders

Description

Tool to retrieve a list of all autoresponders. Use when you need to fetch available autoresponders configured in the system.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Campaign

Description

Tool to retrieve a list of undelivered campaigns. Use when you need to fetch campaigns awaiting delivery.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Campaigns

Description

Tool to retrieve a list of all campaigns. Use when you need to fetch all campaigns from the system.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Forms

Description

Tool to retrieve a list of available forms in Enginemailer. Use when you need to discover forms for n8n integration or workflow configuration.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Pages

Description

Tool to retrieve a list of all pages. Use when you need to fetch available pages.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Popups

Description

Tool to retrieve a list of popups from Enginemailer. Use when you need to fetch available popups for n8n workflows.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Subcategories

Description

Tool to retrieve a list of all subcategories (tags). Use when you need to fetch available subcategories for categorizing subscribers.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Templates

Description

Tool to retrieve a list of all email templates. Use when you need to fetch available email templates for campaigns.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Pause Campaign

Description

Tool to pause a scheduled email campaign. Use when you need to halt a campaign before sending to apply updates or adjust schedule.

Action Parameters

CampaignID
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Subscriber (REST API)

Description

Tool to permanently delete a subscriber by email address. Use when you need to remove a subscriber from the account irreversibly.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create/Update Category

Description

Tool to create or update a category for subscriber segmentation. Use when organizing subscribers by common interests for targeted email marketing.

Action Parameters

categoryDesc
stringRequired
categoryName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Subscriber

Description

Tool to update data for an existing subscriber in EngineMailer. Use when you need to modify subscriber information such as custom fields or subcategory assignments.

Action Parameters

customfields
array
email
stringRequired
subcategory
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send Campaign

Description

Tool to send an email campaign immediately. Use when the campaign exists, has at least one recipient, and is not scheduled or already delivered. E.g., 'Send campaign 123 now'.

Action Parameters

CampaignID
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Tag Subscriber to Subcategory

Description

Tool to tag a subscriber to a specific subcategory via N8N API endpoint. Use when you need to categorize or organize subscribers by assigning them to a subcategory.

Action Parameters

email
stringRequired
subcategoryId
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unsubscribe (N8N)

Description

Tool to unsubscribe a subscriber via N8N API endpoint. Use when you need to remove a subscriber from the mailing list using the N8N integration endpoint.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Unsubscribe Subscriber

Description

Tool to unsubscribe a subscriber from the email list. Use when a user requests to be removed from the mailing list or to comply with unsubscribe requests.

Action Parameters

email
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired