- Category: email newsletters
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 159
- Triggers: 0
- Slug:
ACTIVE_TRAIL - Version: 20261101_00
Tools
Add Group Member
Add Group Member
ACTIVE_TRAIL_ADD_GROUP_MEMBERTool to add a member to a group in ActiveTrail. Creates a new contact or adds an existing contact to the specified group. Supports comprehensive contact information including names, phone numbers, addresses, dates, and custom extension fields. The API will not return errors if the contact is already in the group (idempotent operation).Input Parameters
Output
Add Mailing List Member
Add Mailing List Member
Get Contact Growth
Get Contact Growth
ACTIVE_TRAIL_CONTACT_GROWTHRetrieves daily contact growth statistics showing active (subscribed) and inactive (unsubscribed) contact counts over a specified date range. Use this to analyze contact acquisition trends and measure the growth of your subscriber base over time. Returns time-series data with daily breakdowns.Input Parameters
Output
Create a New Group
Create a New Group
ACTIVE_TRAIL_CREATE_A_NEW_GROUPCreates a new contact group in ActiveTrail for organizing and segmenting contacts. Groups are containers for contacts that allow you to: - Organize contacts by category, campaign, or segment - Target specific groups for email/SMS campaigns - Manage contact memberships independently The newly created group will be empty. Use the “Add Group Member” action to add contacts to this group. Returns the complete group details including the assigned group ID.Input Parameters
Output
Create Campaign
Create Campaign
ACTIVE_TRAIL_CREATE_CAMPAIGNTool to create a new email campaign in ActiveTrail. Use when you need to create and return a new campaign for specific groups. The campaign can be configured as an A/B split test, E-commerce campaign, or a regular campaign. Campaign will be created in draft status unless is_sent is set to true.Input Parameters
Output
Create Campaign for Contacts
Create Campaign for Contacts
ACTIVE_TRAIL_CREATE_CAMPAIGN_FOR_CONTACTSCreates a new email campaign targeted to specific contacts by contact IDs or email addresses, with campaign details, HTML design and an optional template.Input Parameters
Output
Create Contact
Create Contact
ACTIVE_TRAIL_CREATE_CONTACTCreates a new contact in ActiveTrail with the provided information. At least one of email or sms must be provided as the primary identifier. All other fields are optional and can be used to enrich the contact profile. Important: Newly created contacts are not automatically assigned to any group. To enable email/SMS campaigns for this contact, you must add them to a group using a separate action after creation. Returns the complete contact record including the assigned contact ID.Input Parameters
Output
Create Content Category
Create Content Category
Create New Mailing List
Create New Mailing List
Create Order
Create Order
Create Segmentation
Create Segmentation
ACTIVE_TRAIL_CREATE_SEGMENTATIONCreate a new contact segmentation in ActiveTrail. Segmentations are rule-based filters that define target audiences based on contact field values (e.g., email equals specific value, city contains text, etc.). Use this to create dynamic segments for campaign targeting, automation workflows, or contact organization. Requires a unique name and at least one base rule with field, operator, and values.Input Parameters
Output
Create Smart Code Site
Create Smart Code Site
ACTIVE_TRAIL_CREATE_SMART_CODE_SITECreates a new Smart Code tracking site in ActiveTrail. Smart Code is ActiveTrail’s web analytics and visitor tracking solution that monitors visitor behavior on your website. Use this action to register a website for Smart Code tracking by providing a site name and domain(s).Input Parameters
Output
Create SMS Campaign
Create SMS Campaign
ACTIVE_TRAIL_CREATE_SMS_CAMPAIGNTool to create a new SMS campaign in ActiveTrail. Use when you need to send SMS messages to segments of your audience with customizable content, sender name, and scheduling options.Input Parameters
Output
Create SMS Operational Message
Create SMS Operational Message
Create Webhook
Create Webhook
ACTIVE_TRAIL_CREATE_WEBHOOKCreate a new webhook for event notifications in ActiveTrail, specifying its name, target URL, and event type.Input Parameters
Output
Delete content category
Delete content category
Delete group member
Delete group member
ACTIVE_TRAIL_DELETE_A_MEMBER_IN_A_GROUPTool to delete a group member by ID. Use when you need to remove a contact from a specific group in ActiveTrail.Input Parameters
Output
Delete Automations
Delete Automations
ACTIVE_TRAIL_DELETE_AUTOMATIONSTool 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.Input Parameters
Output
Delete Campaign
Delete Campaign
Delete Contact
Delete Contact
ACTIVE_TRAIL_DELETE_CONTACTTool to permanently remove a contact from the ActiveTrail account by their unique contact ID. Use when you need to delete a specific contact. This operation is destructive and cannot be undone. Returns success status and optional message.Input Parameters
Output
Delete group by ID
Delete group by ID
Delete Mailing List
Delete Mailing List
ACTIVE_TRAIL_DELETE_MAILING_LISTTool to permanently remove a mailing list from the ActiveTrail account by its unique ID. Use when you need to delete a mailing list that is no longer needed. This operation is destructive and cannot be undone. Returns success status and confirmation message.Input Parameters
Output
Delete Smart Code Site
Delete Smart Code Site
Delete Template
Delete Template
Delete template category
Delete template category
ACTIVE_TRAIL_DELETE_TEMPLATES_TEMPLATE_CATEGORYTool 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.Input Parameters
Output
Delete Webhook
Delete Webhook
Delete webhook parameter
Delete webhook parameter
ACTIVE_TRAIL_DELETE_WEBHOOKS_PARAMETERSRemoves a specific parameter from a webhook configuration in ActiveTrail. Use this when you need to delete custom headers, query parameters, or body parameters that were previously added to a webhook. Requires both the webhook ID and the specific parameter ID to delete.Input Parameters
Output
Get Account Balance
Get Account Balance
Get specific content category
Get specific content category
ACTIVE_TRAIL_GET_ACCOUNT_CONTENT_CATEGORIES2Tool to retrieve specific category details by ID. Use when you need to get information about a content category from your ActiveTrail account.Input Parameters
Output
Get ActiveCommerce Integration Data
Get ActiveCommerce Integration Data
ACTIVE_TRAIL_GET_ACCOUNT_INTEGRATIONDATARetrieves the account’s ActiveCommerce integration configuration data including mailing list and group associations. This endpoint returns the integration settings that connect ActiveTrail with ActiveCommerce, showing which mailing list and group are configured for the integration. Use this when you need to verify ActiveCommerce integration setup or troubleshoot integration issues.Output
Get Account Merge Status
Get Account Merge Status
Get All Campaign Reports
Get All Campaign Reports
ACTIVE_TRAIL_GET_ALL_CAMPAIGN_REPORTSTool 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.Input Parameters
Output
Get All Groups
Get All Groups
ACTIVE_TRAIL_GET_ALL_GROUPSTool 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 100 groups per page.Input Parameters
Output
Get All Sent Campaigns
Get All Sent Campaigns
ACTIVE_TRAIL_GET_ALL_SENT_CAMPAIGNSTool 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.Input Parameters
Output
Get Automation Log
Get Automation Log
ACTIVE_TRAIL_GET_AUTOMATION_LOGTool 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.Input Parameters
Output
Get Automation Queue Logs
Get Automation Queue Logs
ACTIVE_TRAIL_GET_AUTOMATION_REPORTS_LOG_AUTOMATION_QUEUERetrieve contacts that did not finish a specified automation. Use the automation ID to view contacts remaining in its queue.Input Parameters
Output
Get Automation SMS Campaign Summary Report
Get Automation SMS Campaign Summary Report
ACTIVE_TRAIL_GET_AUTOMATION_REPORTS_SMS_CAMPAIGN_SUMMARYTool 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.Input Parameters
Output
Get Automation Email Campaign Summary Report
Get Automation Email Campaign Summary Report
ACTIVE_TRAIL_GET_AUTOMATION_REPORTS_SUMMARY_REPORTTool to retrieve email campaigns’ summary reports for a specific automation. Use when you need to analyze email campaign performance metrics including opens, clicks, click-to-open rate, conversions, bounces, unsubscribes, and spam complaints within an automation for a given date range.Input Parameters
Output
Get Automations
Get Automations
ACTIVE_TRAIL_GET_AUTOMATIONSList ActiveTrail account automations with optional state filtering and pagination. The returned total is the number of automations in the returned page, not an account-wide count.Input Parameters
Output
Get Automation Details
Get Automation Details
ACTIVE_TRAIL_GET_AUTOMATIONS_DETAILSTool 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.Input Parameters
Output
Get Automation Email Campaign Steps
Get Automation Email Campaign Steps
ACTIVE_TRAIL_GET_AUTOMATIONS_EMAIL_CAMPAIGN_STEPSRetrieve the email campaign steps configured in a specified automation. The results may include subject, scheduling, and tracking details for its send-email steps.Input Parameters
Output
Get Automation SMS Campaign Steps
Get Automation SMS Campaign Steps
ACTIVE_TRAIL_GET_AUTOMATIONS_SMS_CAMPAIGN_STEPSTool 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.Input Parameters
Output
Get Automation Trigger Types
Get Automation Trigger Types
Get Campaign Bounces
Get Campaign Bounces
ACTIVE_TRAIL_GET_CAMPAIGN_BOUNCESTool 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.Input Parameters
Output
Get Campaign Click-Through Data
Get Campaign Click-Through Data
ACTIVE_TRAIL_GET_CAMPAIGN_CLICKSRetrieves detailed click-through data for all links in a campaign or optionally for a specific link. Returns comprehensive information including contact details (name, email), click timestamps, device information (browser, OS, device type), and click counts. Default date range: last 3 months from current date. Use this for aggregate click analysis across multiple links; for detailed analysis of a single link, consider using ‘Get Click Details by Link ID’ action instead. Returns an error if the campaign wasn’t sent within the specified date range.Input Parameters
Output
Get Campaign Design
Get Campaign Design
ACTIVE_TRAIL_GET_CAMPAIGN_DESIGNTool 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.Input Parameters
Output
Get Campaign Domains Report
Get Campaign Domains Report
ACTIVE_TRAIL_GET_CAMPAIGN_DOMAINS_REPORTRetrieves a campaign performance report grouped by recipient email domain, including sends, opens, clicks, bounces, and engagement metrics. A 404 response is returned as an empty report.Input Parameters
Output
Get Campaign Opens
Get Campaign Opens
ACTIVE_TRAIL_GET_CAMPAIGN_OPENSRetrieves contacts who opened a campaign, with pagination and optional group filtering; the default search covers campaigns updated in the last three months. Campaigns not sent in the specified range yield an empty list, and a 404 is also returned as an empty result.Input Parameters
Output
Get Campaign Report
Get Campaign Report
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTRetrieves comprehensive performance metrics for a specific email campaign by its ID. Returns detailed statistics including send count, open rate, click rate, click-to-open rate (CTO), bounce rate, unsubscribe rate, spam complaints, and conversion data. Use this when you need detailed performance analytics for a single campaign. Default behavior: Returns data for campaigns updated in the last 3 months when date parameters are not specified. Note: Returns an error if the campaign wasn’t sent/updated within the specified date range.Input Parameters
Output
Get Campaign Bounced Emails by Type
Get Campaign Bounced Emails by Type
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_BOUNCEDTool 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.Input Parameters
Output
Get Campaign Spam Complaints
Get Campaign Spam Complaints
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_COMPLAINTSRetrieve contacts who reported a campaign as spam, optionally filtered by group and date. The default search covers campaigns updated in the last three months; an out-of-range campaign or a 404 response yields an empty result.Input Parameters
Output
Get Campaign Email Activity Report
Get Campaign Email Activity Report
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_EMAIL_ACTIVITYTool 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.Input Parameters
Output
Get Campaign Sent Emails
Get Campaign Sent Emails
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_SENTRetrieve a campaign’s sent-email report, optionally filtered by group and date. The default search covers campaigns updated in the last three months; an out-of-range campaign or a 404 response yields an empty result.Input Parameters
Output
Get Campaign Unopened Contacts
Get Campaign Unopened Contacts
ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_UNOPENEDRetrieve contacts who did not open a campaign, optionally filtered by group and date. The default search covers campaigns updated in the last three months; an out-of-range campaign or a 404 response yields an empty result.Input Parameters
Output
Get Campaign Scheduling
Get Campaign Scheduling
ACTIVE_TRAIL_GET_CAMPAIGN_SCHEDULINGRetrieves the scheduling configuration for a specific email campaign, including send status and scheduled datetime. Use this action when you need to check if a campaign is scheduled to send, when it’s scheduled to send (in UTC), or verify the send status of a campaign. The response includes is_sent flag (whether campaign is dispatched) and scheduled_date_utc (planned send datetime). Campaign ID can be obtained from campaign list actions.Input Parameters
Output
Get Campaign by ID
Get Campaign by ID
ACTIVE_TRAIL_GET_CAMPAIGN_S_DETAILSTool 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.Input Parameters
Output
Get Campaign Details
Get Campaign Details
ACTIVE_TRAIL_GET_CAMPAIGNS_DETAILSTool to retrieve detailed campaign information including name, subject, and settings. Use when you need to get comprehensive details about a specific email campaign.Input Parameters
Output
Get Campaign Segment Settings
Get Campaign Segment Settings
ACTIVE_TRAIL_GET_CAMPAIGNS_SEGMENTTool to retrieve campaign sending settings including target groups and sending restrictions. Use when you need to get the segmentation configuration for a specific campaign.Input Parameters
Output
Get Sent Campaigns
Get Sent Campaigns
Get Campaign Template
Get Campaign Template
ACTIVE_TRAIL_GET_CAMPAIGN_TEMPLATERetrieves template details (design, content, subject line, sender info) for a specific email campaign. Use this action when you need to: - View the template configuration used in a campaign - Get HTML/plain text content of a campaign template - Retrieve sender information (from name, from email, reply-to) - Access template metadata like category, creation/modification dates Note: Requires a valid campaign ID which can be obtained from the ‘Get Sent Campaigns’ action.Input Parameters
Output
Get Campaign Unsubscribed Contacts
Get Campaign Unsubscribed Contacts
ACTIVE_TRAIL_GET_CAMPAIGN_UNSUBSCRIBEDRetrieves the list of contacts who unsubscribed from a specific email campaign. Use this action when you need to: - Identify which recipients opted out of receiving future communications from a campaign - Analyze unsubscribe patterns and reasons for a particular campaign - Track campaign unsubscribe metrics and contact details By default, searches campaigns updated within the last 3 months. If the campaign wasn’t sent within the specified date range, an empty list is returned. Supports pagination for large unsubscribe lists.Input Parameters
Output
Get Commerce Schema
Get Commerce Schema
Get Contact Activity
Get Contact Activity
Get Contact Details
Get Contact Details
Get Contact Fields
Get Contact Fields
Get Contact Groups
Get Contact Groups
ACTIVE_TRAIL_GET_CONTACT_GROUPSTool to retrieve all groups associated with a specific contact. Returns group details including group ID, name, member counts, and creation dates. Use when you need to list a contact’s group memberships by contact ID.Input Parameters
Output
Get Contact List
Get Contact List
ACTIVE_TRAIL_GET_CONTACT_LISTRetrieves account contacts filtered by customer status and state-change date, with optional email or SMS search and pagination. The date filter defaults to three months back, and the endpoint defaults to 20 records per page.Input Parameters
Output
Get Contact's Errors
Get Contact's Errors
Get Contact's Mailing Lists
Get Contact's Mailing Lists
ACTIVE_TRAIL_GET_CONTACTS_MAILINGLISTSTool 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.Input Parameters
Output
Get Contacts Merges
Get Contacts Merges
ACTIVE_TRAIL_GET_CONTACTS_MERGESTool 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.Input Parameters
Output
Get Contact SMS Statistics
Get Contact SMS Statistics
ACTIVE_TRAIL_GET_CONTACT_SMS_STATISTICSTool to retrieve contact interaction statistics for a specific transactional SMS. Use when you need to see how a contact interacted with a transactional/operational SMS including delivery status, bounce information, and unsubscribe actions.Input Parameters
Output
Get Contact's Statistics for Campaign
Get Contact's Statistics for Campaign
ACTIVE_TRAIL_GET_CONTACTS_STATISTICS_CAMPAIGNTool to retrieve contact’s interaction statistics for a specific campaign. Use when you need to see how a specific contact engaged with a campaign including opens, clicks, bounces, unsubscribes, and spam complaints.Input Parameters
Output
Get Contacts Subscription All Contacts
Get Contacts Subscription All Contacts
ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_ALL_CONTACTSTool 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.Input Parameters
Output
Get Contacts Subscription Status
Get Contacts Subscription Status
ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_CUSTOMERS_STATUSGet daily contact status statistics over a date range, including counts for active, unsubscribed, bounced, quarantined, spam complaints, inactive, and user-requested removals. The default date range goes back three months.Input Parameters
Output
Get Contacts Subscription Subscribers
Get Contacts Subscription Subscribers
ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_SUBSCRIBERSTool to retrieve all contacts who subscribed and the source of their subscription status. Use when you need to get a comprehensive list of subscribers. The search defaults to 3 months back if date range is not specified.Input Parameters
Output
Get Contacts Subscription Unsubscribers
Get Contacts Subscription Unsubscribers
ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_UNSUBSCRIBERSRetrieve unsubscribed contacts and their status source when known, with date filtering and pagination. The search defaults to three months back when no date range is specified.Input Parameters
Output
Get Contacts Unsubscribers SMS
Get Contacts Unsubscribers SMS
ACTIVE_TRAIL_GET_CONTACTS_UNSUBSCRIBERS_SMSTool 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.Input Parameters
Output
Get Contacts With SMS State
Get Contacts With SMS State
ACTIVE_TRAIL_GET_CONTACTS_WITH_SMS_STATETool 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.Input Parameters
Output
Get Content Categories
Get Content Categories
Get Customer Stats for Transactional Message
Get Customer Stats for Transactional Message
ACTIVE_TRAIL_GET_CUSTOMER_STATS_FOR_TRANSACTIONAL_MESSAGETool 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.Input Parameters
Output
Get Executive Report
Get Executive Report
ACTIVE_TRAIL_GET_EXECUTIVE_REPORTRetrieve executive performance report for the ActiveTrail account, providing email marketing metrics over the past 12 months. Returns monthly statistics including emails sent, bounce rates, open rates, click rates, click-to-open rates, complaint rates, and unsubscribe rates for both marketing campaigns and transactional emails. Use this to analyze overall account performance trends and generate summary statistics.Output
Get External Schema
Get External Schema
Get Group Details
Get Group Details
ACTIVE_TRAIL_GET_GROUPTool 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.Input Parameters
Output
Get Group Contents by ID
Get Group Contents by ID
ACTIVE_TRAIL_GET_GROUP_CONTENTS_BY_IDTool 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.Input Parameters
Output
Get Group Events
Get Group Events
ACTIVE_TRAIL_GET_GROUPS_EVENTSTool 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.Input Parameters
Output
Get Landing Pages
Get Landing Pages
ACTIVE_TRAIL_GET_LANDING_PAGESTool to retrieve landing pages from the ActiveTrail account with pagination support. Use when you need to get all landing pages or fetch paginated results.Input Parameters
Output
Get Mailing List
Get Mailing List
Get Mailing List Members
Get Mailing List Members
ACTIVE_TRAIL_GET_MAILING_LIST_MEMBERSRetrieve a page of members from a specific ActiveTrail mailing list, with optional filtering by contact status and state change date range. Use pagination to request further results.Input Parameters
Output
Get Mailing Lists
Get Mailing Lists
Get Order
Get Order
Get Push Campaign Opens
Get Push Campaign Opens
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_OPENSRetrieves a list of contacts who opened a specific push notification campaign, including contact details and when they opened the notification. Use this action to: - Track engagement metrics for push campaigns - Identify which recipients interacted with your push notifications - Filter opens by date range, send type, or search for specific contacts Note: The campaign must have been sent within the date range (defaults to last 3 months from current date if not specified). Results are paginated for campaigns with many opens.Input Parameters
Output
Get Push Campaign Delivered Report
Get Push Campaign Delivered Report
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_DELIVEREDTool 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.Input Parameters
Output
Get Push Campaign Failed Delivery Report
Get Push Campaign Failed Delivery Report
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_FAILEDTool 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).Input Parameters
Output
Get Push Campaign Reports
Get Push Campaign Reports
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORTSRetrieves push notification campaign performance metrics and reports filtered by date range, send type, or search term. Returns analytics including sent count, delivered count, opened count, clicked count, open rate, click rate, and delivery status for each campaign. Default behavior: Returns the last 20 campaigns from the last 3 months when no parameters are specified.Input Parameters
Output
Get Push Campaign Sent Report
Get Push Campaign Sent Report
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_SENTRetrieve a paginated sent-recipient report for a specific push campaign, with optional send type, search term, and date filters. The campaign must have been sent within the selected date range, which defaults to the last three months.Input Parameters
Output
Get Push Campaign Report Summary
Get Push Campaign Report Summary
ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_SUMMARYTool to retrieve aggregated summary statistics for push notification campaigns filtered by date range. Returns total counts across all campaigns including total sent, opens, clicks, clickers, unsubscribes, failed deliveries, and total devices. Use this when you need overall push campaign performance metrics rather than individual campaign details. Default behavior: Returns aggregate statistics for campaigns from the last 3 months when date parameters are not specified.Input Parameters
Output
Get Push Campaigns
Get Push Campaigns
ACTIVE_TRAIL_GET_PUSH_CAMPAIGNSTool 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.Input Parameters
Output
Get Segmentation Rule Field Types
Get Segmentation Rule Field Types
ACTIVE_TRAIL_GET_SEGMENTATION_RULE_FIELD_TYPESRetrieve a reference dictionary of all available field types that can be used in segmentation rules for ActiveTrail automation. Returns field type definitions including their identifiers, names, data types, and descriptions. This endpoint provides the foundational metadata needed to understand which contact fields (email, phone, custom fields, behavioral data, etc.) can be evaluated when constructing segmentation conditions in marketing automations. Use this when you need to discover what field types are available before building or validating segmentation rules.Output
Get Segmentation Rule Operations
Get Segmentation Rule Operations
ACTIVE_TRAIL_GET_SEGMENTATION_RULE_OPERATIONSRetrieves available rule operations for segmentation by field type. Returns operations categorized by field types (Info, Date, Action, Numeric, etc.) with their corresponding operation types (Is, IsNot, Contain, GreaterThan, etc.). Use this to understand which operations are valid when building segmentation rules based on field types.Output
Get Segmentation Rule Types
Get Segmentation Rule Types
Get Segmentation Rule Types Mapping
Get Segmentation Rule Types Mapping
ACTIVE_TRAIL_GET_SEGMENTATION_RULE_TYPES_MAPPINGTool to retrieve the complete mapping of segmentation rule types with their associated field types and operations from ActiveTrail. Use this when building segmentation rules to understand which field types and operations are available for each rule type (e.g., Info rules support Email fields with ‘Is’ operation).Output
Get Segmentations
Get Segmentations
ACTIVE_TRAIL_GET_SEGMENTATIONSRetrieve all contact segmentations from your ActiveTrail account. Segmentations are rule-based filters that define target audiences for campaigns and automations (e.g., contacts who opened specific campaigns, belong to certain groups, or match demographic criteria). Use this to list all configured segmentations and their IDs for use in campaign targeting or automation workflows.Output
Get Sending Profiles
Get Sending Profiles
Get Signup Forms
Get Signup Forms
Get Smart Code Sites
Get Smart Code Sites
ACTIVE_TRAIL_GET_SMART_CODE_SITESRetrieves all Smart Code tracking sites configured in the ActiveTrail account. Smart Code is ActiveTrail’s web analytics and visitor tracking solution. Use this action to list all registered websites with Smart Code tracking, including their IDs, names, and associated domains.Output
Get SMS Campaign by ID
Get SMS Campaign by ID
Get SMS Campaign Clickers
Get SMS Campaign Clickers
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_CLICKERSRetrieve contacts who clicked links in an SMS campaign with detailed click analytics. Returns contact information (name, email, phone), click timestamps, link details, and click counts. Supports filtering by specific links, date ranges, and contact search. Note: If the SMS was sent using “add numbers manually” instead of groups/mailing lists, you’ll receive click counts but mobile numbers may not be available. Default search window is 3 months from today.Input Parameters
Output
Get SMS Campaign Delivered Report
Get SMS Campaign Delivered Report
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_DELIVEREDTool 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.Input Parameters
Output
Get SMS Campaign Estimate
Get SMS Campaign Estimate
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_ESTIMATETool to calculate the estimated number of messages for a given SMS campaign. Use when you need to get message count estimates for campaigns that have not been sent yet. Cannot be used for already-sent campaigns.Input Parameters
Output
Get SMS Campaign Report
Get SMS Campaign Report
Get SMS Campaign Report Clicks
Get SMS Campaign Report Clicks
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_CLICKSTool to retrieve detailed click event data for links in SMS campaigns. Returns individual click records (not unique clickers) with contact information, timestamps, link details, and device/browser information. Use when you need granular click-level analytics for SMS campaign links. Note: By default, searches for clicks within the last 3 months. If the campaign wasn’t sent in the specified date range, no data will be returned. If SMS recipients were added manually (not from a group), you may get click counts but not all contact details.Input Parameters
Output
Get SMS Campaign Failed Delivery Report
Get SMS Campaign Failed Delivery Report
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_FAILEDTool 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.Input Parameters
Output
Get SMS Campaign Reports
Get SMS Campaign Reports
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORTSRetrieves SMS campaign performance reports with filtering options, including sent, delivered, failed, click and engagement statistics when available. By default, campaigns last updated in the past three months are searched.Input Parameters
Output
Get SMS Campaign Sent Contacts Report
Get SMS Campaign Sent Contacts Report
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_SENTRetrieve a paginated sent-recipient report for an SMS campaign sent within the selected date range, which defaults to the last three months. For manually entered numbers, the report provides a count without individual numbers.Input Parameters
Output
Get SMS Campaign Report Summary
Get SMS Campaign Report Summary
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_SUMMARYRetrieve aggregate summary metrics for SMS campaigns across a filtered date range. Returns total counts for sent messages, failed deliveries, clicks, unique clicks, unsubscribes, and credits consumed. Use this to get high-level performance statistics across all SMS campaigns in a given period. Default behavior: Returns aggregate metrics for the last 3 months when date parameters are not specified.Input Parameters
Output
Get SMS Campaign Unsubscribed Contacts
Get SMS Campaign Unsubscribed Contacts
ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_UNSUBSCRIBEDTool 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.Input Parameters
Output
Get SMS Sending Profiles
Get SMS Sending Profiles
Get Template
Get Template
ACTIVE_TRAIL_GET_TEMPLATETool 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.Input Parameters
Output
Get Template Content
Get Template Content
Get Templates
Get Templates
ACTIVE_TRAIL_GET_TEMPLATESTool 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.Input Parameters
Output
Get Template Categories
Get Template Categories
Get Transactional Messages Classification
Get Transactional Messages Classification
Get Transactional SMS Message
Get Transactional SMS Message
ACTIVE_TRAIL_GET_TRANSACTIONAL_SMS_MESSAGETool 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.Input Parameters
Output
Get Two-Way SMS Replies
Get Two-Way SMS Replies
ACTIVE_TRAIL_GET_TWO_WAY_SMS_REPLIESTool 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.Input Parameters
Output
Get Automation Update Actions
Get Automation Update Actions
ACTIVE_TRAIL_GET_UPDATE_ACTIONSRetrieves all available update action types that can be applied to contacts within automation workflows. Each action type includes its ID, name, description, type category, and required parameters. Use this to discover what contact update operations are available when building or modifying automation workflows (e.g., updating contact fields, changing status, adding tags, etc.).Output
Get Webhook by ID
Get Webhook by ID
ACTIVE_TRAIL_GET_WEBHOOKTool 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.Input Parameters
Output
Get Webhooks
Get Webhooks
ACTIVE_TRAIL_GET_WEBHOOKSTool 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.Input Parameters
Output
Get Webhook Parameters
Get Webhook Parameters
ACTIVE_TRAIL_GET_WEBHOOKS_PARAMETERSRetrieves custom parameters configured for a specific webhook. Parameters define additional data (headers, query parameters, or body fields) that ActiveTrail includes when calling the webhook URL. Use this to inspect webhook configuration details including parameter keys, values, types, and dynamic field mappings.Input Parameters
Output
Import New Contacts
Import New Contacts
ACTIVE_TRAIL_IMPORT_NEW_CONTACTSImport up to 1,000 contacts into an ActiveTrail group, optionally associating them with a mailing list. Contact data can include a deletion flag; the response may contain a success count and contact import errors.Input Parameters
Output
List SMS Campaigns
List SMS Campaigns
ACTIVE_TRAIL_LIST_SMS_CAMPAIGNSTool 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.Input Parameters
Output
List Transactional SMS Messages
List Transactional SMS Messages
Create Campaign from Template
Create Campaign from Template
ACTIVE_TRAIL_POST_TEMPLATES_CAMPAIGNCreates a new email campaign from an existing template. The campaign will be created in draft status. Prerequisites: - A valid template ID (obtain from ‘Get Templates’ action) - A valid sending profile ID (obtain from ‘Get Sending Profiles’ action) Use this when you need to quickly create a campaign using a pre-designed template rather than building from scratch.Input Parameters
Output
Create Template Category
Create Template Category
Add Webhook Parameter
Add Webhook Parameter
ACTIVE_TRAIL_POST_WEBHOOKS_PARAMETERSTool to add a new parameter to an existing webhook in your ActiveTrail account. Use when you need to configure additional parameters for webhook events, such as authentication headers, custom query parameters, or body fields. Each parameter can have either a static value or dynamically pull from contact fields.Input Parameters
Output
Send Test Webhook Request
Send Test Webhook Request
Update content category
Update content category
ACTIVE_TRAIL_PUT_ACCOUNT_CONTENT_CATEGORIESUpdate a specific ActiveTrail content category by ID, supplying both its name and display order.Input Parameters
Output
Update Campaign Segment Settings
Update Campaign Segment Settings
ACTIVE_TRAIL_PUT_CAMPAIGNS_SEGMENTTool 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.Input Parameters
Output
Remove Contact from Mailing List
Remove Contact from Mailing List
ACTIVE_TRAIL_REMOVE_A_CONTACT_FROM_A_MAILING_LISTRemoves a specific contact from a mailing list in ActiveTrail.Input Parameters
Output
Remove external contacts from group
Remove external contacts from group
ACTIVE_TRAIL_REMOVE_EXTERNAL_CONTACT_FROM_GROUPRemove external contacts from a specific ActiveTrail group using each contact’s external ID and external name. Up to 1,000 contacts can be supplied per call.Input Parameters
Output
Send Operational Message
Send Operational Message
ACTIVE_TRAIL_SEND_OPERATIONAL_MESSAGETool to send operational email messages to individual recipients (limited to 500 messages per request). Use when you need to send transactional or automated emails with personalized content. Recipients will be created as contacts in your account if they don’t already exist.Input Parameters
Output
Send Operational Message Email
Send Operational Message Email
ACTIVE_TRAIL_SEND_OPERATIONAL_MESSAGE_EMAILTool to send transactional/operational email messages via ActiveTrail. Use when you need to send automated emails like order confirmations, password resets, or notifications. Supports dynamic text replacement via key-value pairs and can send to multiple recipients (max 500).Input Parameters
Output
Test Webhook
Test Webhook
ACTIVE_TRAIL_TEST_WEBHOOKSend a test request to a configured webhook to verify it’s working correctly. This action triggers a test event for the specified webhook without waiting for actual events to occur. Use this to validate that the webhook URL is reachable, properly configured, and able to receive notifications from ActiveTrail. The webhook must already exist in your ActiveTrail account.Input Parameters
Output
Update Campaign
Update Campaign
ACTIVE_TRAIL_UPDATE_CAMPAIGNTool 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.Input Parameters
Output
Update Campaign Design
Update Campaign Design
ACTIVE_TRAIL_UPDATE_CAMPAIGN_DESIGNTool 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.Input Parameters
Output
Update Campaign Scheduling
Update Campaign Scheduling
ACTIVE_TRAIL_UPDATE_CAMPAIGN_SCHEDULINGTool 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.Input Parameters
Output
Update Campaign Details
Update Campaign Details
ACTIVE_TRAIL_UPDATE_CAMPAIGN_S_DETAILSUpdates an email campaign’s core details including name, subject line, sender profile, category, and delivery settings. Important: Only campaigns in DRAFT status can be updated. Attempting to update sent or scheduled campaigns will fail. Use ‘Get Campaign by ID’ first to verify the campaign is in draft mode before updating.Input Parameters
Output
Update Campaign Template
Update Campaign Template
ACTIVE_TRAIL_UPDATE_CAMPAIGN_TEMPLATETool 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.Input Parameters
Output
Update Contact
Update Contact
Update Group
Update Group
ACTIVE_TRAIL_UPDATE_GROUPUpdates an existing group in ActiveTrail by its ID. Primary use case: Rename a group by updating its name field. Important notes: - Only the ‘name’ field is reliably updateable via this endpoint - The API typically returns HTTP 204 (No Content) on success - Group must exist or will return 404 error Use ‘Get All Groups’ or ‘Get Group by ID’ actions to find the group ID first.Input Parameters
Output
Update Order
Update Order
ACTIVE_TRAIL_UPDATE_ORDERUpdates an existing ActiveTrail commerce order by ID, including customer information, shipping address, status, pricing, product items, and purchase date.Input Parameters
Output
Update Segmentation
Update Segmentation
ACTIVE_TRAIL_UPDATE_SEGMENTATIONTool to update an existing segmentation’s name and/or rules by its ID. Use when you need to modify segmentation criteria or rename a segment. Segmentations are rule-based filters that define target audiences based on contact attributes, behaviors, or campaign interactions.Input Parameters
Output
Update Smart Code Site
Update Smart Code Site
ACTIVE_TRAIL_UPDATE_SMART_CODE_SITEUpdates an existing Smart Code tracking site in ActiveTrail. Use this action to modify a site’s name and domain configuration. Both name and domains must be provided in the update request (the API does not support partial updates).Input Parameters
Output
Update SMS Operational Message
Update SMS Operational Message
ACTIVE_TRAIL_UPDATE_SMS_OPERATIONAL_MESSAGETool to update an operational SMS transactional message by ID. Use when you need to modify the name, sender, or content of an existing SMS campaign. Important: You cannot update a campaign that has already been sent.Input Parameters
Output
Update Template
Update Template
ACTIVE_TRAIL_UPDATE_TEMPLATETool to update an existing email template in ActiveTrail account. Use this action to modify template properties including: - Template name and subject line - HTML content/body - Editor type and display settings - Template categorization - Character encoding settings All fields except ‘id’ are optional - only provide the fields you want to update. The template will be updated with the new values while preserving any fields not specified. Note: To update only the HTML content of a template, consider using the ‘Update Template Content’ action instead.Input Parameters
Output
Update Template Category
Update Template Category
Update Template Content
Update Template Content
ACTIVE_TRAIL_UPDATE_TEMPLATE_CONTENTTool 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.Input Parameters
Output
Update Webhook
Update Webhook
ACTIVE_TRAIL_UPDATE_WEBHOOKUpdate an existing ActiveTrail webhook’s configuration, including its name, URL, event type, format, or active status. Name and URL are required; if state ID or type ID is omitted, the request sends 10 and 1 respectively.Input Parameters
Output
Update Webhook Parameter
Update Webhook Parameter
ACTIVE_TRAIL_UPDATE_WEBHOOK_PARAMETERTool to update an existing webhook parameter in your ActiveTrail account. Use when you need to modify parameter properties such as key, value, type, or field mappings for webhook events.