Active trail

Learn how to use Active trail with Composio

Overview

SLUG: ACTIVE_TRAIL

Description

ActiveTrail is the world’s friendliest email marketing platform, newsletter software and marketing automation software.

Authentication Details

generic_api_key
stringRequired

Connecting to Active trail

Create an auth config

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

1

Select App

Navigate to [Active trail](https://platform.composio.dev?next_page=/marketplace/Active trail).

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 Active trail 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
4active_trail_auth_config_id = "ac_YOUR_ACTIVE_TRAIL_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 Active trail 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, active_trail_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 [Active trail toolkit’s playground](https://app.composio.dev/app/Active trail)

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

Tool List

Tool Name: Add Group Member

Description

Tool to add a member to a group in ActiveTrail. Use when you need to add a contact to a specific group with their email and optional contact details.

Action Parameters

email
stringRequired
first_name
string
group_id
integerRequired
last_name
string
sms_number
string
status
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact Growth

Description

Tool to retrieve executive report on contact growth showing daily active and inactive contact growth. Use when you need to measure the increase in amount of contacts over a date range.

Action Parameters

from_date
string
to_date
string

Action Response

data
object
error
string
successful
booleanRequired
successfull
boolean

Tool Name: Create or Update Group Member

Description

Tool to create or update a member in a group. Use when you need to add a new contact to a specific group or update an existing member's details. The API will not return errors if the address is already in the group.

Action Parameters

anniversary
string
birthday
string
campaign_id
integer
city
string
email
string
encryptedext1
string
encryptedext2
string
encryptedext3
string
encryptedext4
string
ext1
string
ext2
string
ext3
string
ext4
string
ext5
string
ext6
string
fax
string
first_name
string
group_id
integerRequired
is_do_not_mail
boolean
is_trigger_events
boolean
last_name
string
phone1
string
phone2
string
street
string
zip_code
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create a New Group

Description

Tool to create a new group in ActiveTrail. Use when you need to add a new group to organize and segment contacts.

Action Parameters

active_counter
integer
counter
integer
created
string
last_generated
string
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Contact

Description

Tool to create a new contact in ActiveTrail. Use when you need to add a new contact to the system. Note: Newly created contacts won't be linked to any group, making email/SMS delivery impossible until assigned to a group. Either email or sms must be provided.

Action Parameters

anniversary
string
birthday
string
city
string
date1
string
date2
string
date3
string
date4
string
date5
string
email
string
ext1
string
ext10
string
ext11
string
ext12
string
ext13
string
ext14
string
ext15
string
ext16
string
ext17
string
ext18
string
ext19
string
ext2
string
ext20
string
ext21
string
ext22
string
ext23
string
ext24
string
ext25
string
ext3
string
ext4
string
ext5
string
ext6
string
ext7
string
ext8
string
ext9
string
fax
string
first_name
string
last_name
string
num1
integer
num2
integer
num3
integer
num4
integer
num5
integer
phone1
string
phone2
string
sms
string
street
string
subscribe_ip
string
zip_code
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Content Category

Description

Tool to create a new content category in ActiveTrail account. Use when you need to add a new category for organizing campaigns and templates.

Action Parameters

display_order
integer
is_default
boolean
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create New Mailing List

Description

Tool to create a new mailing list in ActiveTrail. Use when you need to add a new mailing list to organize and manage contacts.

Action Parameters

name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Order

Description

Tool to create new orders in ActiveTrail commerce system. Use when you need to add order records with customer information, products, and transaction details. Accepts an array of order objects for batch creation.

Action Parameters

orders
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Smart Code Site

Description

Tool to create a new Smart Code site in ActiveTrail. Use when you need to set up a new Smart Code site with a name and associated domain(s).

Action Parameters

domains
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Webhook

Description

Tool to create a new webhook for event notifications in ActiveTrail. Use when you need to set up webhooks to receive real-time notifications for events like contact changes or campaign activities.

Action Parameters

event_type
stringRequired
format
string
is_active
boolean
name
stringRequired
parameters
array
stateid
integer
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete content category

Description

Tool to delete a specific content category by ID. Use when you need to remove a category from your ActiveTrail account.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete group member

Description

Tool to delete a group member by ID. Use when you need to remove a contact from a specific group in ActiveTrail.

Action Parameters

contact_id
integerRequired
group_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Automations

Description

Tool to delete one or more automations from Active Trail. Use when you need to remove automations by their IDs. Supports bulk deletion by providing comma-separated IDs.

Action Parameters

ids
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Campaign

Description

Tool to remove a campaign from ActiveTrail account. Use when you need to delete a campaign that is no longer needed.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Contact

Description

Tool to remove a contact from the ActiveTrail account. Use when you need to permanently delete a contact identified by their unique ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete group by ID

Description

Tool to delete a group by ID. Use when you need to permanently remove a group from ActiveTrail. This is a destructive operation that cannot be undone.

Action Parameters

group_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Group Member

Description

Tool to remove a member from a group in ActiveTrail. Use when you need to delete a contact from a specified group.

Action Parameters

id
stringRequired
memberId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Mailing List

Description

Tool to remove a mailing list from ActiveTrail account. Use when you need to permanently delete a mailing list. This is a destructive operation that cannot be undone.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Mailing List Member

Description

Tool to remove a member from a mailing list in ActiveTrail. Use when you need to delete a contact from a specified mailing list.

Action Parameters

id
stringRequired
memberId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Smart Code Site

Description

Tool to remove a Smart Code site from ActiveTrail. Use when you need to permanently delete a Smart Code site identified by its unique ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Template

Description

Tool to remove a template from ActiveTrail account. Use when you need to delete a template that is no longer needed.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete template category

Description

Tool to delete a template category by ID. Use when you need to remove a template category. Warning: Deleting a category will cascade-delete all templates within that category.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete webhook parameter

Description

Tool to delete a given webhook parameter from your account's webhook configuration. Use when you need to remove a specific parameter associated with a webhook.

Action Parameters

parameter_id
stringRequired
webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Account Balance

Description

Tool to retrieve email and SMS credit balance for the account. Use when you need to check available email and SMS credits.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get specific content category

Description

Tool to retrieve specific category details by ID. Use when you need to get information about a content category from your ActiveTrail account.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get ActiveCommerce Integration Data

Description

Tool to retrieve the account's ActiveCommerce integration data. Use when you need to fetch ActiveCommerce integration configuration and settings.

Action Parameters

Action Response

data
object
error
string
successful
booleanRequired
successfull
boolean

Tool Name: Get Account Merge Status

Description

Tool to check if the account has awaited merges. Use when you need to verify pending merge operations in the ActiveTrail account.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get List of All SMS Campaign Clickers

Description

Tool to retrieve all contacts who clicked on links in an SMS campaign. Use when you need information about which contacts engaged with links in your SMS campaigns. Note: Mobile numbers are only returned if the SMS was sent to a group; manually added numbers will only show click counts. The search defaults to the last 3 months for campaigns.

Action Parameters

from_date
string
id
stringRequired
limit
integer
link_id
string
page
integer
previous_row_count
integer
rows_affected
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All Campaign Reports

Description

Tool to retrieve a full overview of all campaign reports with comprehensive metrics. Use when you need to get reports for all campaigns including send date, opened emails, number of clicks, CTO, bounces, unsubscribers, complaints, unopened and sent emails. Default behavior: Returns campaigns filtered by last update date within the previous 3 months when date parameters are not specified. Default limit is 20 records per page, maximum is 100.

Action Parameters

from_date
string
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All Groups

Description

Tool to retrieve the full list of account groups with pagination and filtering. Use when you need to get all groups or search for groups by name. Default limit is 20 groups per page.

Action Parameters

limit
integer
page
integer
search_term
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get All Sent Campaigns

Description

Tool to retrieve campaigns with optional filtering by date, mailing list, and search criteria. Use when you need to get campaigns filtered by date range (default is last 3 months), limited to a specific number (default is 100), or filtered by mailing list.

Action Parameters

content_category_id
string
from_date
string
limit
integer
mailing_list_id
string
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Delivered List

Description

Tool to get a specific SMS campaign's delivered list data. Use when you need to retrieve contacts who successfully received the SMS message. Note: If SMS was sent using manual number entry, only delivery count is returned.

Action Parameters

from_date
string
limit
integer
page
integer
search_term
string
send_type
string
sms_campaign_id
stringRequired
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get SMS Campaign Recipient Data

Description

Tool to get a specific SMS campaign's 'sent to' data as a list. Use when you need to retrieve detailed recipient information for an SMS campaign. The search defaults to the last 3 months; campaigns outside the date range return no information.

Action Parameters

from_date
string
limit
integer
page
integer
search_term
string
send_type
integer
sms_campaign_id
integerRequired
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Unsubscribed List

Description

Tool to get a specific SMS campaign's unsubscribed data as a list. Use when you need to retrieve contacts who opted out of receiving future SMS messages from a specific campaign. Note: If SMS was sent using manual number entry, only the unsubscribe count is returned without individual phone numbers. Default search range is last 3 months.

Action Parameters

from_date
string
limit
integer
page
integer
previous_row_count
integer
rows_affected
integer
search_term
string
send_type
string
sms_campaign_id
stringRequired
to_date
string

Action Response

count
integer
data
array
error
string
limit
integer
page
integer
page_size
integer
successful
booleanRequired
total
integer
unsubscribes
array

Tool Name: Get Automation Log

Description

Tool to track contacts through automation journey by retrieving detailed logs. Use when you need to see which contacts started a specific automation and their progress through each step of the workflow.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Automation Queue Logs

Description

Tool to retrieve contacts that did not finish a specific automation. Use when you need to get the list of contacts remaining in the automation queue for a given automation ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Automation SMS Campaign Summary Report

Description

Tool to retrieve SMS campaigns' summary reports for a specific automation. Use when you need to analyze SMS campaign performance including sent, delivered, failed, credits consumed, unsubscribe, and click metrics within an automation.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Automations

Description

Tool to list account automations with filtering and pagination. Use when you need to retrieve automations from the ActiveTrail account. Supports filtering by state and pagination parameters.

Action Parameters

limit
integer
page
integer
state_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Automation Details

Description

Tool to retrieve detailed configuration of a specific automation excluding step-by-step execution details. Use when you need metadata about automation behavior, scheduling, reporting settings, and operational constraints.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Automation Email Campaign Steps

Description

Tool to retrieve all email campaign steps in an automation workflow. Use when you need to get details about all 'send email' steps configured within a specific automation, including email content, scheduling, and tracking settings.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Automation SMS Campaign Steps

Description

Tool to retrieve all SMS campaign steps in an automation workflow. Use when you need to get details about all 'send SMS' steps configured within a specific automation, including SMS content, scheduling, and tracking settings.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Automation Trigger Types

Description

Tool to retrieve all available start trigger options for automations. Use when you need to get the list of trigger types that can initiate automation workflows in ActiveTrail.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Bounces

Description

Tool to retrieve bounce details by domain for a specific campaign. Use when you need to analyze campaign bounce rates and identify problematic email domains. Defaults to campaigns updated in the last 3 months.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Campaign Click-Through Data

Description

Tool to access click-through data for a specific campaign. Use when you need to retrieve detailed information about link clicks, including contact details, timestamps, and device information. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.

Action Parameters

from_date
string
id
stringRequired
limit
integer
link_id
string
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Complaints

Description

Tool to retrieve contacts who reported a specific campaign as spam. Use when you need to identify which contacts flagged your campaign as unwanted. Supports filtering by Group ID and date range with pagination.

Action Parameters

campaign_id
stringRequired
from_date
string
groupid
string
limit
integer
page
integer
to_date
string

Action Response

data
array
error
string
successful
booleanRequired

Tool Name: Get Campaign Design

Description

Tool to retrieve campaign design configuration including visual layout and HTML content. Use when you need to get the design details of a specific email campaign.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Domains Report

Description

Tool to retrieve a report by domain for a specific campaign. Use when you need to analyze campaign performance grouped by recipient email domains, including sends, opens, clicks, bounces, and engagement metrics per domain. Defaults to campaigns updated in the last 3 months.

Action Parameters

campaign_id
stringRequired
from_date
string
limit
integer
page
integer
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Campaign Opens

Description

Tool to retrieve contacts who opened a specific campaign. Use when you need to identify which recipients opened your campaign email. By default, searches for campaigns updated in the last 3 months. Can filter by contact group and date range.

Action Parameters

from_date
string
groupid
integer
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Report

Description

Tool to retrieve an overview report for a specific campaign. Use when you need to get campaign performance metrics including sends, opens, clicks, and engagement statistics. Note: If the campaign wasn't sent within the specified date range, an error will be returned.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Bounced Emails by Type

Description

Tool to retrieve bounced email details filtered by bounce type for a specific campaign. Use when you need detailed information about which contacts' emails bounced and why, with the ability to filter by hard or soft bounces.

Action Parameters

bounce_type
string
id
stringRequired
limit
integer
page
integer

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Campaign Click Details Report

Description

Tool to retrieve click details report for a specific campaign. Use when you need to get detailed information about clicks on links in a campaign, including contact information, click timestamps, and device details. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Spam Complaints

Description

Tool to retrieve contacts who reported a specific campaign as spam. Use when you need to identify which contacts flagged your campaign as unwanted. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.

Action Parameters

from_date
string
groupid
string
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Campaign Email Activity Report

Description

Tool to retrieve all contacts' activity on a specific campaign. Use when you need comprehensive activity data including opens, clicks, bounces, and other engagement metrics for each contact in a campaign. By default, the search covers campaigns updated in the last 3 months; if the campaign wasn't sent in the specified date range, an error will be returned.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Campaign Sent Emails

Description

Tool to retrieve contacts who received a specific campaign email. Use when you need to identify which recipients successfully received your campaign. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.

Action Parameters

from_date
string
groupid
string
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Campaign Unopened Contacts

Description

Tool to retrieve contacts who did not open a specific campaign. Use when you need to identify which recipients received but did not open your campaign email. The default search window is the last 3 months; if the campaign wasn't sent during the specified dates, an empty list is returned.

Action Parameters

from_date
string
groupid
string
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Campaign Scheduling

Description

Tool to retrieve campaign schedule configuration including timing and delivery settings. Use when you need to get the scheduling details of a specific email campaign.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign by ID

Description

Tool to retrieve complete campaign information including send settings, design, template, and A/B test configuration. Use when you need comprehensive details about a specific email campaign.

Action Parameters

campaign_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Details

Description

Tool to retrieve detailed campaign information including name, subject, and settings. Use when you need to get comprehensive details about a specific email campaign.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign by ID (Copy)

Description

Tool to retrieve complete campaign information including send settings, design, template, and A/B test configuration. Use when you need comprehensive details about a specific email campaign.

Action Parameters

campaign_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Segment Settings

Description

Tool to retrieve campaign sending settings including target groups and sending restrictions. Use when you need to get the segmentation configuration for a specific campaign.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Sent Campaigns

Description

Tool to retrieve a list of all sent campaigns from ActiveTrail. Use when you need to view all campaigns that have been sent, including their details such as name, subject, send status, and delivery metrics.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Template

Description

Tool to retrieve template details associated with a specific campaign. Use when you need to get the template information used in a campaign.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Unopened Contacts

Description

Tool to retrieve contacts who did not open a specific campaign. Use when you need to identify recipients who received but did not open your campaign email. Default search covers campaigns updated in the last 3 months; if the campaign wasn't sent during the specified date range, an empty list is returned. Supports pagination and filtering by group.

Action Parameters

campaign_id
integerRequired
from_date
string
groupid
integer
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Campaign Unsubscribed Contacts

Description

Tool to retrieve contacts who unsubscribed from a specific email campaign. Use when you need to identify which recipients opted out of receiving future emails. The search defaults to campaigns updated within the last 3 months; if the campaign wasn't sent during the specified date range, an empty list is returned.

Action Parameters

from_date
string
id
integerRequired
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact Activity

Description

Tool to retrieve contact's email engagement history including opens and clicks. Use when you need detailed activity data showing which campaigns were sent to a contact and their engagement metrics.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact Bounces

Description

Tool to retrieve bounce activity for a specific contact by contact ID. Use when you need to understand email delivery failures and bounce patterns for a contact's email address.

Action Parameters

contact_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact Fields

Description

Tool to retrieve account contact fields filtered by type. Use when you need to get contact field definitions from the ActiveTrail account.

Action Parameters

fields_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact Groups

Description

Tool to retrieve all groups associated with a specific contact. Use when you need to list a contact's group memberships by contact ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact List

Description

Tool to retrieve account contacts filtered by status and date range. Use when you need to get a list of contacts filtered by customer status (active, unsubscribed, bounced, etc.) or by registration date. Default behavior: retrieves contacts modified within the last three months with a limit of 100 contacts per page.

Action Parameters

customer_states
string
from_date
string
limit
integer
page
integer
search_term
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact’s Errors

Description

Tool to retrieve bounce and error history for a specific contact. Use when you need to understand delivery issues or bounce patterns for a contact's email address.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contact’s Mailing Lists

Description

Tool to retrieve all mailing lists associated with a specific contact. Use when you need to list a contact's mailing list memberships by contact ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contacts Merges

Description

Tool to retrieve contacts experiencing merge conflicts with filtering options. Use when you need to get the list of contacts with merge conflicts, filtered by status, date range, or limited to a specific number of conflicts.

Action Parameters

from_date
string
limit
integer
page
integer
state_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contacts Subscription All Contacts

Description

Tool to get contacts' subscription status and the source of their status (if known). Use when you need to retrieve all contacts with their subscription status information filtered by creation date. Defaults to three months back if date range is not specified.

Action Parameters

from_date
string
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contacts Subscription Status

Description

Tool to get statistics of contacts' statuses from specific dates. Use when you need to retrieve aggregated contact status statistics between date ranges (defaults to three months back).

Action Parameters

from_date
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contacts Subscription Unsubscribers

Description

Tool to retrieve all contacts who unsubscribed and the source of their unsubscription status. Use when you need to get a comprehensive list of unsubscribers. The search defaults to 3 months back if date range is not specified.

Action Parameters

from_date
string
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contacts Unsubscribers SMS

Description

Tool to retrieve all contacts who unsubscribed from receiving SMS messages. Use when you need to get a list of SMS unsubscribers with optional filtering by date range and pagination support.

Action Parameters

from_date
string
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Contacts With SMS State

Description

Tool to retrieve account's contacts list with SMS subscription state. Use when you need to get contacts filtered by customer status (active, unsubscribed, bounced, etc.) and by state change date range, with default filtering to three months back.

Action Parameters

customer_states
string
from_date
string
limit
integer
page
integer
search_term
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Content Categories

Description

Tool to retrieve all content categories from the ActiveTrail account. Use when you need to get the list of categories used for organizing campaigns and templates.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Customer Stats for Transactional Message

Description

Tool to retrieve customer interaction statistics for a specific transactional message. Use when you need to see how a contact engaged with a transactional/operational message including delivery status, opens, clicks, and other interaction metrics.

Action Parameters

contact_id
integerRequired
transactional_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Executive Report

Description

Tool to retrieve executive performance reports for the ActiveTrail account. Use when you need to get a visual overview of email marketing campaign performance over the past 12 months including sent emails, bounce rates, open rates, click rates, complaints, and unsubscribe rates.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group Details

Description

Tool to retrieve detailed information about a specific group by its unique identifier. Use when you need to fetch group details including name, contact counters, and timestamps.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group by ID

Description

Tool to retrieve detailed information about a specific group by its unique identifier. Use when you need to fetch group content including name, active/total contact counters, and creation timestamps.

Action Parameters

group_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group Contents by ID

Description

Tool to retrieve all group members by group ID with pagination and filtering. Use when you need to get complete information about contacts in a specific group. Returns up to 100 contacts per page with optional filtering by status and date range.

Action Parameters

customer_states
string
from_date
string
group_id
integerRequired
limit
integer
page
integer
search_term
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group Information for Contact

Description

Tool to retrieve all groups that a specific contact belongs to by contact ID. Use when you need to view which groups a contact is associated with.

Action Parameters

contact_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group Events

Description

Tool to retrieve all events for a specific group with optional filtering by event type, event date, and subscriber creation date. Use when you need to analyze group engagement metrics like opens, clicks, and unsubscribes. Default date range is 3 months back if not specified.

Action Parameters

created_from_date
string
created_to_date
string
event_from_date
string
event_to_date
string
event_type
string
id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Landing Pages

Description

Tool to retrieve landing pages from the ActiveTrail account with pagination support. Use when you need to get all landing pages or fetch paginated results.

Action Parameters

limit
integer
page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Mailing List

Description

Tool to retrieve detailed information about a specific mailing list by its unique identifier. Use when you need to fetch details of a single mailing list including name, description, and member counts.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Mailing List Members

Description

Tool to retrieve all members belonging to a specific mailing list. Use when you need to get contacts from a mailing list, with optional filtering by contact status and state change date range.

Action Parameters

customer_states
string
from_date
string
id
stringRequired
limit
integer
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Mailing Lists

Description

Tool to retrieve all mailing lists from the ActiveTrail account. Use when you need to get the list of mailing lists associated with the account.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Order

Description

Tool to retrieve complete details of a specific order from ActiveTrail commerce system. Use when you need to fetch order information including customer details, financial data, products, and shipping information.

Action Parameters

order_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Push Campaign Opens

Description

Tool to retrieve contacts who opened a specific push notification campaign. Use when you need to track which recipients opened your push campaign. The campaign must have been sent within the specified date range (defaults to last 3 months).

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Push Campaign Delivered Report

Description

Tool to retrieve contacts who successfully received a specific push notification campaign. Use when you need to identify which recipients had the push campaign delivered to their devices. The campaign must have been sent within the specified date range (defaults to last 3 months); if not sent during these dates, an empty list is returned.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Push Campaign Failed Delivery Report

Description

Tool to retrieve the failed delivery report for a specific push campaign. Use when you need to see which contacts experienced delivery failures and why. The campaign must be sent in the specified date range (defaults to last 3 months).

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Push Campaign Reports

Description

Tool to retrieve push notification campaign performance metrics and reports. Use when you need to access push campaign analytics including sent, delivered, opened, clicked, and engagement statistics. Returns the last 20 campaigns from the last 3 months by default when no date range is specified.

Action Parameters

from_date
string
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Push Campaign Sent Report

Description

Tool to retrieve contacts who were sent a specific push notification campaign. Use when you need to see the complete list of recipients for a push campaign. The campaign must be sent in the time range specified using from_date and to_date (defaults to last 3 months).

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get Push Campaign Report Summary

Description

Tool to retrieve summary report information of Push campaigns by dates. Use when you need aggregated performance metrics for push notification campaigns including sent, delivered, opened, clicked, and engagement statistics. Default behavior: Returns campaigns from the last 3 months when date parameters are not specified.

Action Parameters

from_date
string
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Push Campaigns

Description

Tool to retrieve push notification campaigns with optional filtering by date, campaign ID, and search criteria. Use when you need to get push campaigns filtered by date range (default is last 6 months and last 20 campaigns), or filtered by specific campaign ID or search term.

Action Parameters

campaign_id
string
filter_type
string
from_date
string
include_deleted
boolean
include_not_sent
boolean
page_number
integer
page_size
integer
search_term
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Segmentation Rule Field Types

Description

Tool to retrieve dictionary of rule field types for segmentation. Use when you need to get available field types for building segmentation rules.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Segmentation Rule Operations

Description

Tool to retrieve dictionary of rule operations for segmentation. Use when you need to get available operations for building segmentation rules.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Segmentation Rule Types

Description

Tool to retrieve dictionary of segmentation rule types for automation. Use when you need to get available rule types for building automation segmentations.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Segmentations

Description

Tool to retrieve all segmentations from the ActiveTrail account. Use when you need to get the list of segmentation configurations associated with the authenticated user's account.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Sending Profiles

Description

Tool to retrieve account email sending profiles. Use when you need to get sending profile configurations including sender names, email addresses, and reply-to settings.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Signup Form

Description

Tool to retrieve detailed information about a specific signup form by its unique identifier. Use when you need to fetch details of a single signup form.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Signup Forms

Description

Tool to retrieve all signup forms from the ActiveTrail account. Use when you need to get the list of signup forms associated with the account.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Smart Code Sites

Description

Tool to retrieve all Smart Code sites from the ActiveTrail account. Use when you need to get the list of Smart Code sites.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign by ID

Description

Tool to retrieve detailed information about a specific SMS campaign by its unique identifier. Use when you need to fetch campaign details including message content, sender, status, and delivery metrics.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Clickers

Description

Tool to access link click data for SMS campaigns. Use when you need to retrieve contacts who clicked links in a specific SMS campaign with optional filtering by link, date range, or search terms. Default search window is 3 months; manually-added numbers may return click counts without mobile numbers.

Action Parameters

from_date
string
id
stringRequired
limit
integer
link_id
string
page
integer
previous_row_count
integer
rows_affected
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Delivered Report

Description

Tool to retrieve delivery confirmations for a specific SMS campaign. Use when you need to see which contacts successfully received the SMS message. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the delivery count is returned without specific mobile numbers.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get SMS Operational Message by ID

Description

Tool to retrieve operational SMS message details by unique identifier. Use when you need to fetch SMS campaign information including sender name, profile, and message content.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Report Clicks

Description

Tool to retrieve SMS clicks (on links) reports for a specific campaign. Use when you need detailed information about link clicks from SMS campaigns, including contact details, timestamps, and device information.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
previous_row_count
integer
rows_affected
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Failed Delivery Report

Description

Tool to retrieve the failed delivery report for a specific SMS campaign. Use when you need to see which contacts experienced delivery failures and why. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the failure count is returned without specific mobile numbers.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Reports

Description

Tool to retrieve SMS campaign performance metrics and reports with filtering options. Use when you need to access SMS campaign analytics including sent, delivered, failed, clicks, and engagement statistics. Returns the last 20 campaigns from the last 6 months by default when no date range or filters are specified.

Action Parameters

from_date
string
limit
integer
page
integer
previous_row_count
integer
rows_affected
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Sent Contacts Report

Description

Tool to retrieve all contacts that an SMS campaign was sent to. Use when you need to see the list of recipients for a specific SMS campaign. The campaign must be sent in the specified date range (defaults to last 3 months). Note: If SMS was sent using manual number entry instead of a group, only the contact count is returned without specific mobile numbers.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
previous_row_count
integer
rows_affected
integer
search_term
string
send_type
string
to_date
string

Action Response

data
array
error
string
limit
integer
page
integer
successful
booleanRequired
total
integer

Tool Name: Get SMS Campaign Report Summary

Description

Tool to retrieve summary report information of SMS campaigns by dates. Use when you need aggregated performance metrics for SMS campaigns including sent, delivered, failed, credits consumed, unsubscribe, and click statistics. Default behavior: Returns the last 20 campaigns from the last 3 months when date parameters are not specified.

Action Parameters

from_date
string
limit
integer
page
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Campaign Unsubscribed Contacts

Description

Tool to retrieve contacts who unsubscribed from a specific SMS campaign. Use when you need to identify recipients who opted out of receiving future SMS messages. Note: For manually added numbers, only the count is returned, not individual phone numbers. Default search range is last 3 months; if campaign wasn't sent in the given range, no information will be returned.

Action Parameters

from_date
string
id
stringRequired
limit
integer
page
integer
previous_row_count
integer
rows_affected
integer
search_term
string
send_type
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get SMS Sending Profiles

Description

Tool to retrieve SMS sending profiles configured for the account. Use when you need to get SMS sender profile configurations including sender names and phone numbers.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Template

Description

Tool to retrieve detailed information about a specific template from the account's saved templates. Use when you need to fetch template details including name, subject, content, category, and encoding settings.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Template Content

Description

Tool to retrieve HTML content of a specific template. Use when you need to get the HTML markup or design content of a template by its ID.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Templates

Description

Tool to retrieve saved templates from the ActiveTrail account. Use when you need to list all templates or search for templates by name. Supports pagination and filtering.

Action Parameters

limit
integer
page
integer
search_term
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Template Categories

Description

Tool to retrieve all template categories from 'my templates' section. Use when you need to get the list of categories for organizing email templates.

Action Parameters

Action Response

data
object
error
string
successful
booleanRequired
successfull
boolean

Tool Name: Get Transactional Messages Classification

Description

Tool to retrieve all classification options for operational/transactional messages. Use when you need to get available classifications for categorizing and filtering transactional message reports.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: Get Transactional SMS Message

Description

Tool to retrieve detailed information about a specific transactional SMS message by its unique identifier. Use when you need to fetch SMS message content, delivery statistics, and metadata for operational SMS messages.

Action Parameters

transactional_sms_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Two-Way SMS Replies

Description

Tool to retrieve virtual number SMS replies with filtering options. Use when you need to fetch two-way SMS responses for campaigns with optional filtering by search term, campaign ID, or date range.

Action Parameters

campaign_id
integer
from_date
string
limit
integer
page
integer
search_term
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Automation Update Actions

Description

Tool to retrieve all types of actions that can update a contact in an automation. Use when you need to discover available update actions for automation workflows in ActiveTrail.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get User Bounces by Campaign ID

Description

Tool to retrieve specific user details of users that got a bounce by Campaign ID, filtered by bounce type. Use when you need to identify which email addresses bounced and distinguish between soft bounces (temporary failures like mailbox full) and hard bounces (permanent failures like invalid addresses). Hard bounce addresses will be excluded from future sends.

Action Parameters

bounce_type
stringRequired
campaign_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get User Social Accounts

Description

Tool to retrieve social media accounts connected to the ActiveTrail account. Use when you need to view connected social platforms.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Webhook by ID

Description

Tool to retrieve detailed information about a specific webhook by its unique identifier. Use when you need to fetch complete webhook configuration including event type, target URL, state, and associated parameters.

Action Parameters

webhook_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Webhooks

Description

Tool to list account webhooks with optional filtering. Use when you need to retrieve webhooks configured for the ActiveTrail account with filtering by event type, state, or target type.

Action Parameters

event_type
string
is_ignore_parameters
boolean
state_type
string
target_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Webhook Parameters

Description

Tool to retrieve webhook parameters for a specified webhook ID. Use when you need to fetch parameter details including parameter ID, key, value, parameter type, and event value type.

Action Parameters

webhook_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Import New Contacts

Description

Tool to import new contacts into a group in ActiveTrail. Use when you need to bulk import contacts with customer information (limited to 1000 contacts per call). Returns success count and any errors for failed contact imports.

Action Parameters

contacts
arrayRequired
group
integerRequired
mailing_list
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Landing Pages

Description

Tool to retrieve landing pages from ActiveTrail. Use 0 as landing_page_id to get all landing pages, or provide a specific ID to get a single landing page.

Action Parameters

landing_page_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Mailing Lists

Description

Tool to list mailing lists from ActiveTrail account. Use when you need to retrieve all mailing lists or get details of a specific mailing list by ID.

Action Parameters

mailinglist_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Members Of A Mailing List

Description

Tool to get all information of your mailing list members by page, limited to 50 contacts each time. Use when you need to retrieve members from a specific mailing list with optional filtering by contact status and state change date range.

Action Parameters

customer_states
string
from_date
string
limit
integer
mailinglist_id
stringRequired
page
integer
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Sign-Up Forms

Description

Tool to retrieve signup forms from the ActiveTrail account. Use when you need to get a list of all signup forms (by using signup_form_id=0) or details of a specific signup form (by providing the form ID).

Action Parameters

signup_form_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List SMS Campaigns

Description

Tool to retrieve SMS campaigns with optional filtering by date, search term, and type. Use when you need to get SMS campaigns filtered by date range (default is last 3 months) or other criteria. Returns up to 20 campaigns per page by default.

Action Parameters

filter_type
string
from_date
string
is_include_not_sent
boolean
limit
integer
page
integer
search_term
string
to_date
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Specific SMS Campaign

Description

Tool to retrieve a specific SMS campaign by ID including full details like content, status, targeting, and scheduling. Use when you need comprehensive information about a particular SMS campaign.

Action Parameters

sms_campaign_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Transactional SMS Messages

Description

Tool to retrieve all SMS transactional messages with pagination support. Use when you need to fetch the list of operational SMS campaigns configured in the account.

Action Parameters

limit
integer
page
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Campaign from Template

Description

Tool to create a campaign using a specific template. Use when you need to create a new email campaign based on an existing template.

Action Parameters

campaign_details
objectRequired
template_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Template Category

Description

Tool to create a new template category in ActiveTrail. Use when you need to add a new category for organizing email templates.

Action Parameters

name
stringRequired
name_key
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Webhook Parameter

Description

Tool to update a given webhook parameter configuration in your ActiveTrail account. Use when you need to add or update parameters for webhook events such as headers, query parameters, or body data.

Action Parameters

event_parameter_type
stringRequired
event_value_type
stringRequired
key
stringRequired
user_field
string
value
stringRequired
webhook_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Send Test Webhook Request

Description

Tool to send a test webhook request with configurable URL and parameters. Use when you need to validate webhook configurations by sending a test request to a specified URL with custom event types, parameters, and target types.

Action Parameters

event_type
stringRequired
format
integerRequired
parameters
array
target_type
stringRequired
url
stringRequired
user_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update content category

Description

Tool to update a specific content category by ID. Use when you need to modify the name or display order of a category in your ActiveTrail account.

Action Parameters

display_order
integerRequired
id
integerRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Campaign Details

Description

Tool to update campaign details in ActiveTrail. Use when you need to modify campaign properties like name, subject, or settings. Note: Only campaigns in draft mode can be updated.

Action Parameters

content_category_id
integerRequired
google_analytics_name
string
id
integerRequired
name
stringRequired
predictive_delivery
booleanRequired
preheader
string
subject
stringRequired
user_profile_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Campaign Segment Settings

Description

Tool to update campaign sending settings including groups and sending restrictions. Use when you need to modify which groups receive a campaign. Note: Only campaigns in draft mode can be updated.

Action Parameters

group_ids
arrayRequired
id
integerRequired
restricted_group_ids
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove Contact from Mailing List

Description

Tool to remove a contact from a mailing list in ActiveTrail. Use when you need to delete a specific contact from a mailing list.

Action Parameters

contact_id
stringRequired
mailinglist_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove external contacts from group

Description

Tool to remove contacts from a group via external ID. Use when you need to delete external contacts from a specific group in ActiveTrail. Limited to 1000 contacts per call.

Action Parameters

external_contacts
arrayRequired
group_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Test Webhook

Description

Tool to send a test request for a given webhook by its ID. Use when you need to validate an existing webhook configuration without requiring actual trigger events.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Campaign

Description

Tool to update draft campaigns in ActiveTrail. Use when you need to modify campaign properties such as name, subject, content, or design settings. IMPORTANT: Only campaigns in draft mode can be updated - campaigns that have been sent or are scheduled cannot be modified.

Action Parameters

design
objectRequired
details
objectRequired
id
integerRequired
send_test
string
send_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Campaign Design

Description

Tool to update the design and HTML content of an email campaign in ActiveTrail. Use when you need to modify a campaign's visual layout, HTML content, or encoding settings. Important: Only campaigns in draft mode can be updated through this endpoint.

Action Parameters

content
stringRequired
header_footer_language_type
string
id
integerRequired
is_add_print_email
boolean
is_auto_css_inliner
boolean
is_remove_system_links
boolean
language_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Campaign Scheduling

Description

Tool to configure send schedule for draft campaigns. Use when you need to update the scheduling configuration of a campaign. Only campaigns in draft mode can be updated.

Action Parameters

id
integerRequired
is_sent
booleanRequired
scheduled_date_utc
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Campaign Details

Description

Tool to update a campaign's details by ID in ActiveTrail. Use when you need to modify campaign properties like name, subject, sender profile, or settings. Important: Only campaigns in draft mode can be updated.

Action Parameters

content_category_id
integerRequired
google_analytics_name
string
id
integerRequired
name
stringRequired
predictive_delivery
booleanRequired
preheader
string
subject
stringRequired
user_profile_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Campaign Template

Description

Tool to update the template associated with an email campaign in ActiveTrail. Use when you need to assign or change a template for a campaign. Important: Only campaigns in draft mode can be updated through this endpoint.

Action Parameters

campaign_id
integerRequired
template_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Contact

Description

Tool to update an existing contact's information by ID. Use when you need to modify contact details such as name, email, phone, address, or custom fields. Only the fields you include in the request will be updated; other fields remain unchanged.

Action Parameters

anniversary
string
birthday
string
city
string
date1
string
date2
string
date3
string
date4
string
date5
string
double_opt_in_config
object
email
string
ext1
string
ext10
string
ext11
string
ext12
string
ext13
string
ext14
string
ext15
string
ext16
string
ext17
string
ext18
string
ext19
string
ext2
string
ext20
string
ext21
string
ext22
string
ext23
string
ext24
string
ext25
string
ext3
string
ext4
string
ext5
string
ext6
string
ext7
string
ext8
string
ext9
string
fax
string
first_name
string
id
integerRequired
is_deleted
boolean
last_name
string
num1
integer
num2
integer
num3
integer
num4
integer
num5
integer
phone1
string
phone2
string
sms
string
sms_status
string
status
string
street
string
subscribe_ip
string
zip_code
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Contact Details

Description

Tool to update an existing contact's information in ActiveTrail. Use when you need to modify contact data by contact ID or email address. Changes are permanent and cannot be undone. Include only the fields you want to update in the request.

Action Parameters

anniversary
string
birthday
string
campaign_id
string
city
string
contact_id
stringRequired
email
string
encryptedext1
string
encryptedext2
string
encryptedext3
string
encryptedext4
string
ext1
string
ext2
string
ext3
string
ext4
string
ext5
string
ext6
string
fax
string
first_name
string
is_do_not_mail
boolean
is_optin
boolean
is_trigger_events
boolean
last_name
string
phone1
string
phone2
string
sms
string
state
string
status
string
street
string
zip_code
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Group

Description

Tool to update an existing group by ID. Use when you need to modify group properties such as name, counters, or timestamps in ActiveTrail.

Action Parameters

active_counter
integer
counter
integer
created
string
id
integerRequired
last_generated
string
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Rename Group

Description

Tool to rename a group's name in ActiveTrail. Use when you need to change the name of an existing group.

Action Parameters

group_id
integerRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Order

Description

Tool to modify existing orders in ActiveTrail commerce system. Use when you need to update order details such as customer information, order status, pricing, or items. Requires the order ID.

Action Parameters

address
string
city
string
currency
string
email
string
firstName
string
items
array
lastName
string
mobile
string
netAmount
number
orderId
string
orderName
string
order_id
stringRequired
purchaseDate
string
status
string
tax
number
totalAmount
number
totalPrice
number

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Smart Code Site

Description

Tool to update an existing Smart Code site in ActiveTrail. Use when you need to modify site details such as name or associated domains.

Action Parameters

domains
string
id
stringRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Template

Description

Tool to update an existing template in ActiveTrail account. Use when you need to modify template properties such as name, subject, content, category, or encoding settings.

Action Parameters

AddPrintButton
boolean
campaign_encoding
integer
content
string
editor_type
string
id
integerRequired
name
string
subject
string
template_category_id
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Template Content

Description

Tool to update the HTML content of an email template in ActiveTrail. Use when you need to modify the design or layout of an existing template.

Action Parameters

content
stringRequired
id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Webhook

Description

Tool to update an existing webhook configuration in ActiveTrail. Use when you need to modify webhook properties such as name, URL, event type, format, or active status.

Action Parameters

event_type
string
format
integer
id
integerRequired
is_active
boolean
name
stringRequired
stateid
integer
typeid
integer
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired