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

Tools

Slug: 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

string
Fax number
string
City name
string
Custom extension field 1 for additional contact data
string
Custom extension field 2 for additional contact data
string
Custom extension field 3 for additional contact data
string
Custom extension field 4 for additional contact data
string
Custom extension field 5 for additional contact data
string
Custom extension field 6 for additional contact data
string
required
Contact’s email address (required)
string
Primary phone number (for SMS or calls)
string
Secondary phone number
string
Contact’s subscription status in the group. Note: cannot import a contact in status ‘subscribe’ if they are inactive on ActiveTrail
string
Street address
string
Birthday date in YYYY-MM-DD format
integer
required
The unique identifier for the group to add the member to
string
Postal/ZIP code
string
Contact’s last name
string
Contact’s first name
string
Anniversary date in YYYY-MM-DD format
integer
Campaign identifier to associate with this member
string
Encrypted custom field 1 for sensitive data
string
Encrypted custom field 2 for sensitive data
string
Encrypted custom field 3 for sensitive data
string
Encrypted custom field 4 for sensitive data
boolean
Flag to mark contacts who should not receive mail communications
boolean
Whether to trigger automation events when adding the member

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_ADD_MAILINGLIST_MEMBERAdd a contact to an ActiveTrail mailing list and specified groups, creating a new contact or adding an existing one. Provide an email address or SMS number and at least one group; contact data can include a deletion flag.

Input Parameters

string
Fax number
string
Contact SMS/mobile number (required if email is null)
string
City name
string
Custom extension field 1 for additional contact data
string
Custom extension field 2 for additional contact data
string
Custom extension field 3 for additional contact data
string
Custom extension field 4 for additional contact data
string
Custom extension field 5 for additional contact data
string
Custom extension field 6 for additional contact data
string
Custom extension field 7 for additional contact data
string
Custom extension field 8 for additional contact data
string
Custom extension field 9 for additional contact data
string
Custom numeric field 1
string
Custom numeric field 2
string
Custom numeric field 3
string
Custom numeric field 4
string
Custom numeric field 5
string
Custom date field 1
string
Custom date field 2
string
Custom date field 3
string
Custom date field 4
string
Custom date field 5
string
Contact email address (required if sms is null)
string
Custom extension field 10 for additional contact data
string
Custom extension field 11 for additional contact data
string
Custom extension field 12 for additional contact data
string
Custom extension field 13 for additional contact data
string
Custom extension field 14 for additional contact data
string
Custom extension field 15 for additional contact data
string
Custom extension field 16 for additional contact data
string
Custom extension field 17 for additional contact data
string
Custom extension field 18 for additional contact data
string
Custom extension field 19 for additional contact data
string
Custom extension field 20 for additional contact data
string
Custom extension field 21 for additional contact data
string
Custom extension field 22 for additional contact data
string
Custom extension field 23 for additional contact data
string
Custom extension field 24 for additional contact data
string
Custom extension field 25 for additional contact data
string
Primary phone number
string
Secondary phone number
string
Contact’s subscription status
string
Street address
string
Birthday date
string
Postal/ZIP code
array
required
The groups’ IDs the contacts will be added to (required)
string
Contact’s last name
string
Contact’s first name
boolean
Deletion status flag - set to true to mark contact as deleted
string
SMS subscription status
string
Anniversary date
string
IP address used for subscription
integer
required
The unique identifier for the mailing list to add the member to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
End date (YYYY-MM-DD format) for filtering contact growth data. If not provided, defaults to the current date.
string
Start date (YYYY-MM-DD format) for filtering contact growth data. If not provided, defaults to three months prior to the current date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the group to create. This is the only required field. Must be unique within your account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
E-commerce data for campaign.
array
Key-value pairs for dynamic content replacement and personalization in the email template
object
required
Campaign design configuration containing HTML content and formatting options
object
required
Campaign details including name, subject, and user profile ID
object
Targeting restrictions for campaign audience.
object
Template reference for campaign creation.
string
Comma-separated list of email addresses to send test emails to before launching the campaign
object
required
Campaign scheduling configuration - whether to send immediately or schedule for later
object
A/B test configuration for campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
required
Campaign configuration object containing details, design, and optional template. Can be set as A/B split, E-commerce, or regular campaign.
object
required
Contact targeting information. Provide either contacts_ids or contacts_emails to specify recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Fax number
string
Contact’s SMS phone number. Required if email is not provided
string
City name
string
Extended custom field 1
string
Extended custom field 2
string
Extended custom field 3
string
Extended custom field 4
string
Extended custom field 5
string
Extended custom field 6
string
Extended custom field 7
string
Extended custom field 8
string
Extended custom field 9
integer
Custom numeric field 1
integer
Custom numeric field 2
integer
Custom numeric field 3
integer
Custom numeric field 4
integer
Custom numeric field 5
string
Custom date field 1
string
Custom date field 2
string
Custom date field 3
string
Custom date field 4
string
Custom date field 5
string
Contact’s email address. Required if sms is not provided
string
Extended custom field 10
string
Extended custom field 11
string
Extended custom field 12
string
Extended custom field 13
string
Extended custom field 14
string
Extended custom field 15
string
Extended custom field 16
string
Extended custom field 17
string
Extended custom field 18
string
Extended custom field 19
string
Extended custom field 20
string
Extended custom field 21
string
Extended custom field 22
string
Extended custom field 23
string
Extended custom field 24
string
Extended custom field 25
string
Primary phone number
string
Secondary phone number
string
Street address
string
Contact’s birth date
string
Zip or postal code
string
Contact’s last name
string
Contact’s first name
string
Anniversary date
string
IP address at subscription time

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_CREATE_CONTENT_CATEGORYTool to create a new content category in ActiveTrail account. Use when you need to add a new category for organizing campaigns and templates.

Input Parameters

string
required
Name of the content category to create
boolean
Whether this category should be set as the default category
integer
Display order for the category. Higher numbers appear later in the list

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_CREATE_NEW_MAILING_LISTTool to create a new mailing list in ActiveTrail. Use when you need to add a new mailing list to organize and manage contacts.

Input Parameters

string
required
Name of the mailing list. This is the only required field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_CREATE_ORDERTool 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.

Input Parameters

array
required
Array of order objects to create. At least one order is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Name of the segmentation. Must be unique within your account
object
required
Segmentation rules defining which contacts match this segment. Contains basic_rules_set and optional additional_rules_sets

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Friendly name to identify this Smart Code site (e.g., your website or business name)
string
required
Website domain(s) where Smart Code tracking will be installed. Use comma-separated values for multiple domains (no spaces)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Campaign name for internal use and identification
string
required
SMS message body text to be sent
object
required
Audience definition including group IDs, mailing lists, and delivery restrictions
string
Sender name, up to 11 English letters without special characters or spaces. Required unless sms_sending_profile_id is specified in segment
object
required
Send timing configuration with timezone and scheduling flags
boolean
Enable unsubscription link in the SMS message
Enable link tracking for URLs in the SMS message
string
required
Unsubscribe text to be shown. Required even if unsubscribe link is not used

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_CREATE_SMS_OPERATIONAL_MESSAGETool to create a new operational SMS transactional message. Use when you need to create an SMS campaign for later use or editing.

Input Parameters

string
required
The SMS campaign name/title for internal use
string
required
The SMS message content/text to send
string
required
The sender identifier/name (max 11 English letters, no special characters or spaces)
boolean
Whether unsubscription link is enabled
string
Unsubscribe text shown in the message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_CREATE_WEBHOOKCreate a new webhook for event notifications in ActiveTrail, specifying its name, target URL, and event type.

Input Parameters

string
required
The URL that the webhook will call when triggered
string
required
The name of the webhook
string
required
Event type that triggers the webhook. The most commonly supported value is ‘contact_change’ which fires when contact information is updated. Note: Some event types may require additional configuration or may not be available in all accounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_DELETE_ACCOUNT_CONTENT_CATEGORIESTool to delete a specific content category by ID. Use when you need to remove a category from your ActiveTrail account.

Input Parameters

integer
required
The unique identifier of the category to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier for the group
integer
required
The unique numeric identifier for the contact to remove from the group. Use the contact’s ID obtained from other endpoints like ‘Get Group Contents by ID’ or ‘Create Contact’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Automation identifier(s). For single deletion, provide one ID. For bulk deletion, provide multiple IDs separated by commas (e.g., ‘1,2,3’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_DELETE_CAMPAIGNTool to remove a campaign from ActiveTrail account. Use when you need to delete a campaign that is no longer needed.

Input Parameters

string
required
The unique identifier of the campaign to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique contact ID (numeric string) to permanently delete from the ActiveTrail account

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_DELETE_GROUP_BY_IDTool 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.

Input Parameters

integer
required
The unique identifier for the group to be deleted

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the mailing list to be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_DELETE_SMART_CODE_SITETool to remove a Smart Code site from ActiveTrail. Use when you need to permanently delete a Smart Code site identified by its unique ID.

Input Parameters

string
required
The unique identifier of the Smart Code site to be removed

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_DELETE_TEMPLATETool to remove a template from ActiveTrail account. Use when you need to delete a template that is no longer needed.

Input Parameters

string
required
The unique identifier of the template to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the template category to be deleted. Note: Deleting a category will also delete all templates within it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_DELETE_WEBHOOKTool to remove a webhook from ActiveTrail account by its ID. Use when you need to delete a webhook that is no longer needed.

Input Parameters

integer
required
The unique identifier of the webhook to delete. Can be obtained from the ‘Get Webhooks’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique webhook identifier. Obtain this from the ‘Get Webhooks’ endpoint or from the webhook ID returned when creating a webhook.
integer
required
The unique parameter identifier to delete. Obtain this from the ‘Get Webhook Parameters’ endpoint for the specified webhook, or from the parameter ID returned when creating a parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_ACCOUNT_BALANCETool to retrieve email and SMS credit balance for the account. Use when you need to check available email and SMS credits.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the category to retrieve. Can be found using the endpoint to get the account’s list of categories.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_ACCOUNT_MERGEChecks whether the ActiveTrail account has pending merge operations, returning an awaiting-merges status when available.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination of results. If not provided, the API defaults to page 1. Range: 1 to 2147483647
integer
Number of results per page. If not provided, the API defaults to 20. Maximum: 100
string
End date for filtering campaigns by last update date. If not provided, the API defaults to current date. Format: YYYY-MM-DD
string
Start date for filtering campaigns by last update date. If not provided, the API defaults to 3 months prior to current date. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Range: 1-2147483647. Use this to navigate through multiple pages of results.
integer
Maximum number of groups to return per page. Range: 1-100. Default: 100.
string
Group name to search for. Used to filter groups by name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Default is 0
integer
Maximum number of campaigns to return per page. Default is 100, maximum is 100
string
End date for filtering campaigns in ISO format (YYYY-MM-DD). Default is current date if not specified
string
Start date for filtering campaigns in ISO format (YYYY-MM-DD). Default is 3 months back from current date if not specified
string
Filter campaigns by send type
string
Search campaigns by name or other search criteria
string
Filter campaigns by specific mailing list ID
string
Filter campaigns by content category ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The automation ID for which to retrieve contact logs. This identifies the specific automation workflow whose contact journey logs you want to track.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The automation ID for which to retrieve queue logs. This identifies the specific automation workflow to query.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Automation id. Can be found using the endpoint ‘Get account’s automations’
string
End date for filtering SMS campaign reports. Format: YYYY-MM-DD or ISO 8601 date string.
string
Start date for filtering SMS campaign reports. Format: YYYY-MM-DD or ISO 8601 date string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Automation id. Can be found using the endpoint ‘Get account’s automations’ or in the UI
string
required
End date for report period. Format: YYYY-MM-DD
string
required
Start date for report period. Format: YYYY-MM-DD

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination of results. Used to navigate through multiple pages of automations.
integer
Maximum number of automation records to return per page. Controls the number of results returned in each request.
string
Filter automations by their operational status/state. Used to filter which automations to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Automation identifier. Can be found using the ‘Get account’s automations’ endpoint or via the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Automation ID. Can be found using the ‘Get Automations’ endpoint or in the UI. This identifies the specific automation workflow whose email sending steps you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Automation ID. Can be found using the ‘Get Automations’ endpoint or in the UI. This identifies the specific automation workflow whose SMS sending steps you want to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_AUTOMATION_TRIGGER_TYPESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Campaign identifier. Can be found using the ‘Get account’s email campaigns’ endpoint or in the UI.
integer
Page number for pagination. Use this to navigate through multiple pages of bounce results.
integer
Number of bounce records to return per page. Controls the size of each page in paginated results.
string
End date for filtering bounce results. Format: YYYY-MM-DD. If not provided, defaults to current date.
string
Start date for filtering bounce results. Format: YYYY-MM-DD. If not provided, defaults to three months prior to current date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The campaign identifier for which to retrieve click-through data. Obtain campaign IDs using the ‘Get All Campaign Reports’ action.
integer
Page number for pagination (starting from 1). Use this to navigate through multiple pages of results. Defaults to 1 if not specified.
integer
Number of records to return per page. Controls the size of each page in paginated results. API may have a default limit (typically 20-100) if not specified.
Optional filter to retrieve clicks for a specific link within the campaign. If provided, only returns click data for that link. If omitted, returns clicks across all links in the campaign.
string
End date for filtering click data. Format: YYYY-MM-DD. If not specified, defaults to the current date.
string
Start date for filtering click data. Format: YYYY-MM-DD. If not specified, defaults to 3 months before the current date. Returns an error if the campaign wasn’t sent within the specified date range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the campaign. Can be found using ‘Get account’s email campaigns’ endpoint or in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Specific results page number for pagination. Range: 1-2147483647
integer
Number of results per page. Range: 1-100. Default: 20
string
End date for filtering domain report data. Returns domain statistics up to this date. Format: YYYY-MM-DD
string
Start date for filtering domain report data. Returns domain statistics from this date onwards. Format: YYYY-MM-DD
string
required
Campaign identifier. Can be found using the ‘Get account’s email campaigns’ endpoint or in the UI by navigating to Emails->Emails Lists->clicking on the campaign’s preview (id will be in the URL).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Specific results page number for pagination. Valid range: 1-2147483647.
integer
Limit the number of items in the results. Valid range: 1-100. Defaults to 20 if not provided.
integer
Optional contact group identifier to filter openers from a specific group only.
string
Campaign update end date for filtering. Format: YYYY-MM-DD. If not provided, defaults to current date.
string
Campaign update start date for filtering. Format: YYYY-MM-DD. If not provided, defaults to three months prior to current date.
integer
required
Campaign identifier. Can be found using the ‘Get account’s email campaigns’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Campaign identifier to retrieve the report for. Obtainable via the ‘Get All Campaign Reports’ action or from the UI.
integer
Specific page number for pagination. Range: 1 to 2147483647. Default: 1.
integer
Maximum number of results per page. Range: 1 to 100. Default: 20.
string
End date for filtering campaigns by update date. Default: current date. Format: ISO 8601 date-time (YYYY-MM-DDTHH:MM:SS) or simple date (YYYY-MM-DD).
string
Start date for filtering campaigns by update date. Default: 3 months prior to current date. Format: ISO 8601 date-time (YYYY-MM-DDTHH:MM:SS) or simple date (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The campaign identifier for which to retrieve bounced email details.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string ("hard" | "soft")
Type of bounce to filter results. ‘hard’ for permanent delivery failures, ‘soft’ for temporary failures. If not provided, returns all bounce types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The campaign identifier for which to retrieve spam complaint details.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
Optional filter to get complaints from a specific group only.
string
End date for filtering complaints (format: YYYY-MM-DD). If not specified, API defaults to current date.
string
Start date for filtering complaints (format: YYYY-MM-DD). If not specified, API defaults to 3 months prior to current date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The campaign identifier for which to retrieve email activity details.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results. Maximum: 100.
string
End date for filtering email activity. Format: YYYY-MM-DD.
string
Start date for filtering email activity. Format: YYYY-MM-DD. Default is last 3 months if not specified. Note: if the campaign wasn’t sent in the given dates, you’ll get an error.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The campaign identifier for which to retrieve sent email details.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
Optional filter to get sent emails from a specific group only.
string
End date for filtering sent emails. Default: current date. Format: Date string (YYYY-MM-DD).
string
Start date for filtering sent emails. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The campaign identifier for which to retrieve unopened contact details.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
Optional filter to get unopened contacts from a specific group only.
string
End date for filtering unopened contacts. Default: current date. Format: Date string (YYYY-MM-DD).
string
Start date for filtering unopened contacts. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the campaign. Can be obtained from ‘Get All Campaign Reports’ (ACTIVE_TRAIL_GET_ALL_CAMPAIGN_REPORTS) or ‘Get Sent Campaigns’ (ACTIVE_TRAIL_GET_CAMPAIGNS_SENT_CAMPAIGNS) actions, or from the campaign URL in the ActiveTrail UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Campaign identifier. Can be found using the endpoint ‘Get account’s email campaigns…’ or in the UI

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Campaign identifier. Can be found using the ‘Get account’s email campaigns’ endpoint or via the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the campaign. Can be found using ‘Get account’s email campaigns’ endpoint or in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_CAMPAIGNS_SENT_CAMPAIGNSTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the campaign whose template you want to retrieve. Campaign IDs can be obtained from the ‘Get Sent Campaigns’ (ACTIVE_TRAIL_GET_CAMPAIGNS_SENT_CAMPAIGNS) action or found in the ActiveTrail UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Campaign identifier. The unique ID of the campaign. Can be found via the ‘Get account’s email campaigns’ endpoint or in the UI.
integer
Page number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647.
integer
Number of records to return per page. Controls the size of each page in paginated results. Valid range: 1 to 100. Defaults to 20 if not specified.
string
End date for filtering unsubscribe records by campaign update date. Format: YYYY-MM-DD. Defaults to current date if not specified. Note: Returns empty list if the campaign wasn’t sent within the date range.
string
Start date for filtering unsubscribe records by campaign update date. Format: YYYY-MM-DD. Defaults to 3 months prior to current date if not specified. Note: Returns empty list if the campaign wasn’t sent within the date range.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_COMMERCE_SCHEMATool to retrieve order fields schema information from the ActiveTrail commerce API. Use when you need to get information about available order fields, their types, and custom names for commerce/order management.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_CONTACT_ACTIVITYTool 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.

Input Parameters

integer
required
Contact identifier. Can be found using the ‘Get account’s contacts list’ endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_CONTACT_DETAILSTool to retrieve complete details of a specific contact by their ID. Use when you need full contact information including personal data, contact fields, subscription status, and all custom extended fields.

Input Parameters

integer
required
Unique contact identifier. Can be obtained from the GET /api/contacts endpoint

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_CONTACT_FIELDSRetrieve contact field definitions for the ActiveTrail account, optionally filtered by field type.

Input Parameters

string
Filter contact fields by type. Used to filter which contact fields to retrieve from the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Contact ID to retrieve group memberships for. Can be found using the ‘Get Contact List’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination, zero-indexed. Default: 0 (first page). Note: page=1 will skip the first page of results
integer
Number of results per page. Default: 100. Maximum: 100
string
End date for state change filtering. Defaults to current date if not provided
string
Start date for state change filtering. Defaults to three months back from current date if not provided
string
Search term for filtering contacts across contact fields
string
Filter contacts by customer status. Comma-separated values for multiple statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_CONTACTS_ERRORSTool 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.

Input Parameters

string
required
The unique contact identifier to retrieve bounces for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Contact ID to retrieve mailing lists for. Can be found using the ‘Get account’s contacts list’ endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination of results. Used to navigate through multiple pages of merge conflicts.
integer
Maximum number of merge conflicts to return per page. Controls the number of results returned in each request.
string
End date for filtering merge conflicts (ISO 8601 format: YYYY-MM-DD). Defaults to current date if not specified.
string
Start date for filtering merge conflicts (ISO 8601 format: YYYY-MM-DD). Defaults to three months back if not specified.
string
Filter contacts by conflict status (e.g., active, inactive, deleted). Used to filter which merge conflicts to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Contact identifier. The unique ID of the customer/contact whose SMS interaction statistics you want to retrieve
integer
required
Transactional SMS message identifier. The unique ID of the operational/transactional SMS sent to the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Contact identifier. Can be found using the endpoint ‘Get account’s contacts list…’
integer
required
Campaign identifier. Located via the campaigns endpoint or in the UI under Emails section

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Use this to navigate through multiple pages of results. Must be a positive integer.
integer
Number of records to return per page. Controls the size of each page in paginated results. Must be between 1 and 100.
string
End date for filtering contacts by creation date. Format: YYYY-MM-DD. Defaults to current date if not specified.
string
Start date for filtering contacts by creation date. Format: YYYY-MM-DD. Defaults to 3 months prior to current date if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
End date for filtering contact status statistics. If not provided, defaults to the current date
string
Start date for filtering contact status statistics. If not provided, defaults to three months prior to the current date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647.
integer
Number of records to return per page. Controls the size of each page in paginated results. Valid range: 1 to 100. Defaults to 20 if not specified.
string
End date for filtering subscription records. Limits search to subscriptions that occurred before this date. Format: YYYY-MM-DD. Defaults to current date if not specified.
string
Start date for filtering subscription records. Limits search to subscriptions that occurred after this date. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647.
integer
Number of records to return per page. Controls the size of each page in paginated results. Valid range: 1 to 100. Defaults to 20 if not specified.
string
End date for filtering unsubscription records. Limits search to unsubscribes that occurred before this date. Format: YYYY-MM-DD. Defaults to current date if not specified.
string
Start date for filtering unsubscription records. Limits search to unsubscribes that occurred after this date. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647.
integer
Number of records to return per page. Controls the size of each page in paginated results. Valid range: 1 to 100. Defaults to 20 if not specified.
string
End date for filtering SMS unsubscription records. Limits search to unsubscribes that occurred before this date. Format: YYYY-MM-DD. Defaults to current date if not specified.
string
Start date for filtering SMS unsubscription records. Limits search to unsubscribes that occurred after this date. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of contacts to return per page. Controls the size of each page in paginated results.
string
End date for filtering contacts by state change date. Format: YYYY-MM-DD. If not provided, defaults to three months back from current date.
string
Start date for filtering contacts by state change date. Format: YYYY-MM-DD. If not provided, defaults to three months back from current date.
string
Search term for filtering contacts. Use this to search for specific contacts by name, email, or other identifying information.
string
Filter by customer status. Comma-separated values for multiple states such as ‘active’, ‘unsubscribed’, ‘bounced’, etc. Use this to filter contacts by their subscription state.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_CONTENT_CATEGORIESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Contact identifier. The unique ID of the customer/contact whose interaction statistics you want to retrieve
integer
required
Transactional message identifier. The unique ID of the operational/transactional message sent to the contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_EXTERNAL_SCHEMATool to retrieve contact field schema information for the account. Use when you need to get the structure and metadata of all available contact fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Group identifier. Can be found using the endpoint ‘Get account’s groups’ or in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Range: 1-2147483647. Default: 0.
integer
Number of results per page. Range: 1-100. Default: 100. Maximum limit is 100.
string
End date for state change filtering. ISO 8601 date format. Defaults to current date if not provided.
integer
required
The group identifier. Can be found using the ‘Get All Groups’ endpoint or in the UI.
string
Start date for state change filtering. ISO 8601 date format. Defaults to 3 months prior to current date if not provided.
string
Search filter for members by email or SMS. Note: plus signs not supported.
string
Filter by contact status. Valid values: ‘Subscribed’ (ready to receive email), ‘Unsubscribed’ (opted out), ‘Bounced’ (email bounced), ‘Blocked’ (spam/blocked), ‘Pending’ (awaiting confirmation). Comma-separated for multiple statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Group identifier. Can be found using the endpoint ‘Get account’s groups’ or in the UI.
string
Filter by event type (e.g., opens, clicks, unsubscribes, etc.). If not provided, returns all event types.
string
Filter by event occurrence end date. Format: YYYY-MM-DD.
string
Filter by subscriber creation end date. Format: YYYY-MM-DD.
string
Filter by event occurrence start date. Format: YYYY-MM-DD. Default is 3 months back if not specified.
string
Filter by subscriber creation start date. Format: YYYY-MM-DD. Default is 3 months back if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Range: 1-2147483647. Use this to navigate through multiple pages of results.
integer
Maximum number of landing pages to return per page. Range: 1-100. Default: 20.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_MAILING_LISTTool to retrieve basic information about a specific mailing list by its unique identifier. Returns the mailing list ID and name. Use when you need to verify a mailing list exists or get its name by ID.

Input Parameters

string
required
Mailing list identifier. The unique ID of the mailing list to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Mailing list identifier - the ID of the mailing list to retrieve members from
integer
Page number for pagination. Use this to navigate through multiple pages of results
integer
Maximum number of results per page
string
End date for filtering by state change. Defaults to three months back from current date if not provided. Format: YYYY-MM-DD
string
Start date for filtering by state change. Defaults to three months back if not provided. Format: YYYY-MM-DD
string
Filter results by contact status. Comma-separated values for multiple statuses. Valid values: Subscribed, Unsubscribed, Bounced, Blocked (case-sensitive)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_MAILING_LISTSTool to retrieve all mailing lists from the ActiveTrail account. Use when you need to get the list of mailing lists associated with the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_ORDERTool 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.

Input Parameters

string
required
Unique identifier for the order to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the push campaign to retrieve opens for.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
End date for filtering results. Default: current date. Format: Date string (YYYY-MM-DD).
string
Start date for filtering results. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
string
Filter results by the campaign send type. Common values include ‘immediate’ (sent immediately) or ‘scheduled’ (sent at a scheduled time). Leave empty to include all send types.
string
Search term to filter the results by contact information such as name, email, or phone number. The search is case-insensitive and matches partial strings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the push campaign to retrieve delivered contacts for.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
End date for filtering results. Default: current date. Format: Date string (YYYY-MM-DD).
string
Start date for filtering results. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
string
Filter by send type (immediate, scheduled, etc.).
string
Search term to filter results by contact details or other searchable fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the push campaign to retrieve failed delivery report for.
integer
Page number for pagination. Use this to navigate through multiple pages of failed delivery results.
integer
Number of failed delivery records to return per page. Controls the size of each page in paginated results.
string
End date for filtering failed deliveries. Format: YYYY-MM-DD or datetime string. Default: current date.
string
Start date for filtering failed deliveries. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
string
Filter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
string
Search term to filter contact results by name, email, or other searchable contact fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination (1-based). Use this to navigate through multiple pages of results. If not specified, defaults to page 1.
integer
Maximum number of campaigns to return per page. Controls page size for pagination. If not specified, defaults to 20 campaigns per page.
string
End date for the date range filter (inclusive). Campaigns sent on or before this date will be included. Format: YYYY-MM-DD. If not specified, defaults to the current date.
string
Start date for the date range filter (inclusive). Campaigns sent on or after this date will be included. Format: YYYY-MM-DD. If not specified, defaults to 3 months before the current date.
string
Filter campaigns by send type. Use ‘immediate’ for campaigns sent immediately or ‘scheduled’ for campaigns sent at a scheduled time. Leave empty to return all send types.
string
Search term to filter campaigns by name or other searchable text fields. Partial matches are supported. Leave empty to return all campaigns.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the push campaign to retrieve sent contacts for. Must be a valid push campaign ID.
integer
Page number for pagination. Use this to navigate through multiple pages of sent report results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
End date for filtering sent report. Format: YYYY-MM-DD or datetime string. Default: current date.
string
Start date for filtering sent report. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
string
Filter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
string
Search term to filter contact results by name, email, or other searchable contact fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
End date for filtering campaigns. Default: current date. Format: Date string (YYYY-MM-DD).
string
Start date for filtering campaigns. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD).
string
Filter by send type (immediate, scheduled, etc.).
string
Search term to filter campaign results by campaign name or other searchable fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
End date for filtering campaign results in ISO format (YYYY-MM-DD). Default is current date if not specified
string
Start date for filtering campaign results in ISO format (YYYY-MM-DD). Default is 6 months back if not specified
integer
Number of results per page
string
Filter results by specific campaign identifier
string
Type of filter to apply to campaign results
integer
Page number for pagination
string
Search term to filter campaigns by name or content
boolean
Whether to include deleted campaigns in results
boolean
Whether to include unsent campaigns in results

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_SEGMENTATION_RULE_TYPESRetrieves available segmentation rule types for automation, returning rule type information as a list or mapping for use when creating or editing segmentations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_SENDING_PROFILESTool to retrieve account email sending profiles. Use when you need to get sending profile configurations including sender names, email addresses, and reply-to settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_SIGNUP_FORMSTool to retrieve all signup forms from the ActiveTrail account. Use when you need to get the list of signup forms associated with the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_SMS_CAMPAIGNRetrieves details of a specific SMS campaign by ID, including message content, sender, status, recipient count and timestamps when available.

Input Parameters

integer
required
SMS campaign identifier. Can be found using the endpoint ‘Get account’s SMS campaigns’ or in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
SMS campaign identifier for which to retrieve clickers data. Use the List SMS Campaigns action to find valid campaign IDs.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Results per page limit. Controls the number of records returned per page.
Filter results by specific link identifier. When provided, only returns clickers for that specific link within the campaign.
string
End date for filtering click data. Format: YYYY-MM-DD. Defaults to today if not specified.
string
Start date for filtering click data. Format: YYYY-MM-DD. Default search window is 3 months from today if not specified.
string
Filter by send type classification (e.g., immediate, scheduled).
string
Search term to filter clicker records by contact name, email, or phone number.
integer
Number of rows to return in this request (alternative pagination method to page/limit).
integer
Number of rows already retrieved from previous requests (offset for rows_affected pagination method).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the SMS campaign to retrieve delivered contacts for.
integer
Page number for pagination. Use this to navigate through multiple pages of delivered contact results.
integer
Number of delivered contact records to return per page. Controls the size of each page in paginated results.
string
End date for filtering delivered SMS. Format: YYYY-MM-DD or datetime string. Default: current date.
string
Start date for filtering delivered SMS. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
string
Filter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
string
Search term to filter contact results by name, phone number, or other searchable contact fields.
integer
Number of rows affected. Use for pagination tracking.
integer
Previous row count value. Use for pagination state tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
SMS campaign id. Can be found using the endpoint ‘Get account’s sms campaigns..’ or in the UI. Note: Can only be used for campaigns that were not sent yet.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORTRetrieves a summary report for an SMS campaign by ID, including sent and delivered counts, clicks, and errors when available.

Input Parameters

integer
required
SMS campaign ID. Can be found using the endpoint ‘Get account’s SMS campaigns’ or in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The SMS campaign identifier for which to retrieve click data on links. This is the campaign ID, not a separate report ID. You can get campaign IDs from the ‘Get SMS Campaign Report Summary’ action.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
End date for filtering click reports. Format: YYYY-MM-DD.
string
Start date for filtering click reports. Format: YYYY-MM-DD.
string
Filter by send type (immediate, scheduled, etc.).
string
Search criteria for filtering click results.
integer
Maximum number of rows to return in the result set. Use for pagination to limit results per request.
integer
Offset for pagination - number of rows to skip before starting to return results. Used with rows_affected for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the SMS campaign to retrieve failed delivery report for.
integer
Page number for pagination. Use this to navigate through multiple pages of failed delivery results.
integer
Number of failed delivery records to return per page. Controls the size of each page in paginated results.
string
End date for filtering failed deliveries. Format: YYYY-MM-DD or datetime string. Default: current date.
string
Start date for filtering failed deliveries. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
string
Filter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
string
Search term to filter contact results by name, phone number, or other searchable contact fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination of results. Default: 1
integer
Number of results per page. Default: 20
string
End date for filtering campaigns (ISO 8601 format). Default: current date
string
Start date for filtering campaigns (ISO 8601 format). Default: 3 months prior to current date
string
Filter campaigns by send type (e.g., transactional messages, test messages, or all campaigns excluding transactional)
string
Search term to filter campaign results by campaign name or other searchable fields
integer
Number of rows affected in the query
integer
Count from previous request for pagination tracking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the SMS campaign to retrieve sent contacts report for.
integer
Page number for pagination. Use this to navigate through multiple pages of sent contact results.
integer
Number of sent contact records to return per page. Controls the size of each page in paginated results.
string
End date for filtering sent contacts. Format: YYYY-MM-DD or datetime string. Default: current date.
string
Start date for filtering sent contacts. Format: YYYY-MM-DD or datetime string. Default: 3 months prior to current date.
string
Filter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
string
Search term to filter contact results by name, phone number, or other searchable contact fields.
integer
Advanced pagination parameter: Number of rows to fetch in the current batch. Leave as None for standard pagination using page and limit.
integer
Advanced pagination parameter: The cumulative count of rows from previous pages. Leave as None for standard pagination using page and limit.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
End date for filtering campaigns to include in aggregation. Default: current date. Format: YYYY-MM-DD.
string
Start date for filtering campaigns to include in aggregation. Default: 3 months prior to current date. Format: YYYY-MM-DD.
string
Filter aggregate metrics by send type. Filters which campaigns are included in the aggregation (e.g., ‘immediate’ for immediately sent campaigns, ‘scheduled’ for scheduled campaigns).
string
Filter aggregate metrics by campaign name or other searchable fields. Only campaigns matching this search term will be included in the aggregated totals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The SMS campaign identifier for which to retrieve unsubscribe data. Can be found via the ‘Get account’s sms campaigns’ endpoint or in the UI.
integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Number of records to return per page. Controls the size of each page in paginated results.
string
End date for filtering unsubscribe reports. Format: YYYY-MM-DD. Defaults to current date if not specified.
string
Start date for filtering unsubscribe reports. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified.
string
Filter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent.
string
Search term to filter unsubscribed contacts by name, phone number, or other contact fields.
integer
Number of rows affected in the result set for pagination purposes.
integer
Previous row count for pagination purposes. Used to track position when paginating through results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_SMS_SENDING_PROFILESTool 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Template identifier. Can be obtained from the ‘Get Templates’ action (ACTIVE_TRAIL_GET_TEMPLATES) or from the template URL in the ActiveTrail UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_TEMPLATE_CONTENTTool 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.

Input Parameters

string
required
The unique identifier of the template. Can be found using ‘Get Templates’ endpoint or in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Range: 1-2147483647. Use this to navigate through multiple pages of results.
integer
Maximum number of templates to return per page. Range: 1-100. Controls the number of results returned in each request.
string
Search term for filtering templates by name. Used to find specific templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_TEMPLATES_TEMPLATE_CATEGORYTool to retrieve all template categories from ‘my templates’ section. Use when you need to get the list of categories for organizing email templates.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_TRANSACTIONAL_MESSAGES_CLASSIFICATIONTool to retrieve all classification options for operational/transactional messages. Use when you need to get available classifications for categorizing and filtering transactional message reports.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Transactional SMS message identifier. The unique ID of the operational SMS message to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for paginated results (1-indexed). Use with limit parameter for pagination. Must be between 1-2147483647
integer
Maximum number of reply records to return per page. Must be between 1-100. API defaults to 20 if not specified
string
End date (inclusive) for filtering replies by received date. API defaults to 3 months after from_date if not specified
string
Start date (inclusive) for filtering replies by received date. API defaults to 3 months before to_date if not specified
integer
Filter replies by specific SMS campaign ID. Use ‘Get SMS Campaign by ID’ or ‘Get Specific SMS Campaign’ actions to find campaign IDs
string
Search keyword to filter SMS replies by the reply text content. Matches replies containing this term

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_GET_USER_SOCIAL_ACCOUNTS_GETRetrieve social media accounts connected to the ActiveTrail account, with available details such as platform, username, status, and connection date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the webhook to retrieve. Can be found using the ‘Get Webhooks’ endpoint or in the UI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Filter webhooks by event type. Used to retrieve only webhooks configured for specific events. Common value is ‘contact_change’ which fires when contact information is updated.
string
Filter webhooks by state type. Used to retrieve webhooks based on their operational status (e.g., active, inactive).
string
Filter webhooks by target type. Used to retrieve webhooks based on their target configuration.
boolean
When set to true, the webhook parameters array is excluded from the response to reduce payload size. Use this for faster retrieval when you only need basic webhook information without custom parameter details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Webhook identifier. Obtain this by calling ‘Get Webhooks’ or ‘Get Webhook by ID’ actions first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Group identifier for contact assignment (required). Find using ‘Get account’s groups’ endpoint or via UI: Contacts→Groups→click group name→check URL
array
required
Array of contact objects to import. Maximum 1000 contacts per request.
integer
Mailing list identifier (optional). Locate via ‘Get account’s mailing lists’ endpoint or UI path: Contacts→Mailing Lists→click list name→view URL

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
Page number for pagination. Default is 1
integer
Number of results per page. Default is 20
string
Filter campaigns up to this end date in ISO format (YYYY-MM-DD). Campaigns must be sent in the time range set. Default is current date if not specified
string
Filter campaigns from this start date in ISO format (YYYY-MM-DD). Campaigns must be sent in the time range set. Default is 3 months ago from current date if not specified
string
Filter campaigns by type/status
string
Search campaigns by name or content
boolean
Include campaigns that have not yet been sent

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_LIST_TRANSACTIONAL_SMS_MESSAGESRetrieve a paginated list of transactional SMS messages, also known as operational SMS campaigns, configured in the ActiveTrail account.

Input Parameters

integer
Page number for pagination. Use this to navigate through multiple pages of results.
integer
Maximum number of results to return per page. Controls the page size for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the template to use for campaign creation. Can be obtained from the ‘Get Templates’ action.
object
required
Campaign details including name, subject, and user profile ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_POST_TEMPLATES_TEMPLATE_CATEGORYTool to create a new template category in ActiveTrail. Use when you need to add a new category for organizing email templates.

Input Parameters

string
required
The name of the template category to create. This is a required field.
string
Optional name key identifier. Can be deleted in a post/put endpoints.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Parameter name/key. For headers, use standard header names (e.g., ‘Authorization’, ‘X-API-Key’). For query params, use the query parameter name. For body params, use the JSON field name.
string
required
Parameter value when event_value_type is ‘custom_text’. When event_value_type is ‘user_field’, this field can be empty as the value comes from user_field.
string
Name of the contact field to use as the parameter value. Required when event_value_type is ‘user_field’. Common values: ‘email’, ‘first_name’, ‘last_name’, ‘phone’.
integer
required
The unique identifier of the webhook to add a parameter to. Can be obtained from ‘Get Webhooks’ or ‘Create Webhook’ actions.
string
required
How the parameter value is determined. Valid values: ‘custom_text’ (use static value from ‘value’ field), ‘user_field’ (dynamically use contact field specified in ‘user_field’).
string
required
Where the parameter will be sent. Valid values: ‘header’ (HTTP header), ‘query’ (URL query parameter), ‘body’ (request body field).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_POST_WEBHOOKS_TEST2Tool 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.

Input Parameters

string
required
Target webhook endpoint URL to receive the test request
integer
required
Response format identifier
integer
User identifier
string
required
Event type for the webhook test (e.g., ‘contact_change’)
array
Collection of key-value pairs with event parameter type for custom headers or body parameters
string
required
Target type for the webhook (e.g., ‘zapier’, ‘custom’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_PUT_ACCOUNT_CONTENT_CATEGORIESUpdate a specific ActiveTrail content category by ID, supplying both its name and display order.

Input Parameters

integer
required
The unique identifier of the category to update. Obtain this from the ‘Get Content Categories’ or ‘Get specific content category’ action.
string
required
The new name for the category
integer
required
The display order for the category (determines the position in lists)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Campaign identifier. Only draft campaigns can be updated.
array
required
List of group IDs to target for the campaign. These groups will receive the campaign.
array
List of group IDs to exclude from the campaign. Members of these groups will not receive the campaign even if they belong to target groups.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_REMOVE_A_CONTACT_FROM_A_MAILING_LISTRemoves a specific contact from a mailing list in ActiveTrail.

Input Parameters

string
required
The contact identifier to be removed from the mailing list. Can be obtained from the ‘List Members Of A Mailing List’ action or from contact details in the ActiveTrail interface
string
required
The mailing list identifier from which to remove the contact. Can be obtained from the ‘List Mailing Lists’ action or via UI: Contacts → Mailing Lists → click list name → check URL for ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier for the group from which contacts will be removed
array
required
List of external contacts to remove from the group. Each contact requires both externalId and externalName to match. Maximum 1000 contacts per call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
BCC (Blind Carbon Copy) email addresses configuration.
object
required
Email design configuration including HTML content, language type, and body format (required)
object
required
Message metadata including name, subject, classification, and sender name (required)
array
Array of email recipients with personalization data. Limited to 500 messages per request. If not provided, the message configuration is saved but no emails are sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

object
BCC email configuration.
object
required
Email design configuration. Either provide content (HTML) or template_id.
object
required
Message configuration including name, subject, and classification
array
required
Array of email recipients (maximum 500 recipients per request)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique ID of the webhook to test. This ID can be obtained from the ‘Get Webhooks’ or ‘Get Webhook by ID’ endpoints, or from the ActiveTrail dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The campaign identifier (used in URL path)
object
required
Campaign design configuration containing HTML content and formatting options
object
required
Campaign details object containing name, subject, and configuration
string
Comma-separated list of email addresses for test emails
string
Campaign sending type. ‘Regular’ for standard email campaigns, ‘Empty’ for campaigns without recipients initially.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the campaign whose design should be modified. Only campaigns in draft mode can be updated.
string
required
HTML content for the campaign email body. This is the main visual content that recipients will see.
string
Character encoding type for the email content. Common value is ‘UTF_8’.
boolean
Whether to add a print email option to the campaign. Set to true to include print functionality.
boolean
Whether to automatically inline CSS styles into HTML elements. This improves email client compatibility.
Whether to remove system-generated links (such as unsubscribe links) from the campaign.
Character encoding type for the header and footer sections. Common value is ‘UTF_8’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Campaign identifier. Can be found using the ‘Get account’s email campaigns’ endpoint or from the campaign preview URL in the UI
boolean
required
Flag indicating whether the campaign should be dispatched
string
required
Planned send date/time in UTC format (e.g., ‘2016-12-24T14:12:12’). Cannot be set to a past date

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Campaign identifier. Only draft campaigns can be updated. Use ‘Get Campaign by ID’ or ‘Get Campaign Details’ to retrieve campaign information.
string
required
Internal campaign name for organizing and identifying campaigns within ActiveTrail
string
required
Email subject line that recipients will see in their inbox
string
Preview text displayed after the subject line in email clients (typically 40-100 characters recommended for optimal display)
integer
required
Sender profile ID that defines the ‘from’ name and email address. Use ‘Get Sending Profiles’ to retrieve valid profile IDs.
integer
required
Category ID for organizing campaigns by content type. Use ‘Get Content Categories’ to retrieve valid category IDs.
boolean
required
Enables predictive delivery optimization to send emails at the best time for each recipient (requires this feature to be enabled on your ActiveTrail account)
string
Google Analytics campaign name for tracking email performance in GA (use only English letters, numbers, and underscores - no spaces or special characters)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the campaign whose template should be updated. Only campaigns in draft mode can be updated.
integer
required
The unique identifier of the template to assign to the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_UPDATE_CONTACTUpdates a contact by ID, including contact details, custom fields, subscription status, and deletion status. The deletion status can be set to delete or restore a contact.

Input Parameters

integer
required
Contact ID to update. Can be found using the ‘Get account’s contacts list’ endpoint
string
Fax number
string
Contact’s SMS/phone number. Either email or sms must be provided
string
City
string
Custom extension field 1
string
Custom extension field 2
string
Custom extension field 3
string
Custom extension field 4
string
Custom extension field 5
string
Custom extension field 6
string
Custom extension field 7
string
Custom extension field 8
string
Custom extension field 9
integer
Custom numeric field 1
integer
Custom numeric field 2
integer
Custom numeric field 3
integer
Custom numeric field 4
integer
Custom numeric field 5
string
Custom date field 1
string
Custom date field 2
string
Custom date field 3
string
Custom date field 4
string
Custom date field 5
string
Contact’s email address. Either email or sms must be provided
string
Custom extension field 10
string
Custom extension field 11
string
Custom extension field 12
string
Custom extension field 13
string
Custom extension field 14
string
Custom extension field 15
string
Custom extension field 16
string
Custom extension field 17
string
Custom extension field 18
string
Custom extension field 19
string
Custom extension field 20
string
Custom extension field 21
string
Custom extension field 22
string
Custom extension field 23
string
Custom extension field 24
string
Custom extension field 25
string
Primary phone number
string
Secondary phone number
string
Contact status
string
Street address
string
Birthday date
string
Postal/ZIP code
string
Last name
string
First name
boolean
If true - contact will be deleted. If false - contact will be restored if previously deleted
string
SMS contact status
string
Anniversary date
string
The Subscribe IP address
object
Configuration for double opt-in email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the group to update. Can be found using the ‘Get All Groups’ or ‘Get Group by ID’ actions.
string
New name for the group. This is the primary field you should update. Must be a non-empty string if provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

number
Total tax amount applied to this order (VAT, sales tax, etc.)
string
Shipping address city name
string
Customer’s email address for order communications and receipts
array
List of products/items included in this order. Each item can have quantity, price, and product details
string
Customer’s mobile phone number (include country code for international numbers)
string
Current order fulfillment status. Common values: pending, processing, completed, shipped, cancelled, refunded
string
Customer’s shipping street address (number and street name)
string
Optional: Order identifier to include in the request body. Usually the same as order_id. Only include if you want to change the order ID itself
string
Three-letter ISO 4217 currency code for all monetary amounts in this order
string
Customer’s last (family) name
string
required
Unique identifier for the order to update. This value is used in the API URL path (e.g., /commerce/Order/{order_id})
string
Customer’s first (given) name
number
Subtotal amount before tax is applied (sum of item prices minus discounts)
string
Custom display name or reference label for this order (for internal tracking)
number
Total order price before tax (deprecated: use totalAmount instead)
number
Final grand total amount (netAmount + tax + any additional fees)
string
Date and time when the order was placed. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS with optional timezone)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The segmentation identifier to be updated. Can be found using the ‘Get Segmentations’ action
string
Updated name for the segmentation. If not provided, the name remains unchanged
object
Complete segmentation rules structure containing all rule sets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the Smart Code site to update (used in URL path)
string
required
The updated name for the Smart Code site
string
required
Comma-separated list of domains associated with the Smart Code site (required even for updates)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Operational SMS message ID to update. Can be found in the UI (go to Mobile -> SMS -> SMS list -> filter by ‘Transactional SMS’)
string
required
The SMS campaign name/title for internal use
string
required
The SMS message content/text to send
string
required
The sender identifier/name (max 11 English letters, no special characters or spaces)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The unique identifier of the template to update
string
Template name. Update this to change the template’s display name.
string
HTML or text content of the template. Update this to change the template’s body content.
string
Email subject line. Update this to change the default subject for emails using this template.
string
Template editor type. Specifies which editor was used to create the template. Common values: ‘HTML’ for HTML editor, ‘WYSIWYG’ for visual editor, ‘DragAndDrop’ for drag-and-drop builder.
boolean
Whether to add a print button to the email template. When true, recipients can print the email directly from their email client.
integer
Character encoding for the email campaign. Determines how text is encoded in the email. Common values: 0 for UTF-8 (recommended for international characters), 1 for ISO-8859-1 (Western European), 2 for Windows-1255 (Hebrew).
integer
Category identifier for organizing templates. Use this to categorize templates (e.g., newsletters, promotions, transactional). You can get valid category IDs from the ‘Get Content Categories’ action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ACTIVE_TRAIL_UPDATE_TEMPLATE_CATEGORYTool to update an existing template category in ActiveTrail. Use when you need to modify the name of a template category used for organizing email templates.

Input Parameters

integer
required
Category ID. Can be found using the endpoint ‘Get my templates categories’.
string
required
The category’s name
string
Optional; can be removed in POST/PUT requests

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
The unique identifier of the template to update
string
required
The HTML content for the template. This field contains the email template’s HTML design/layout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
The webhook ID to update. Can be found using the GET /api/webhooks endpoint.
string
required
The target URL that the webhook will call. Must be a full URL including http:// or https://
string
required
The name of the webhook
string
Webhook format specification. Can be a string like ‘json’ or ‘xml’, or an integer code.
integer
Webhook type ID for the API. Defaults to 1 if not provided. Use 1 for standard webhooks.
integer
Webhook state ID for the API. Defaults to 10 if not provided. Use 10 for active webhooks.
boolean
Indicates whether the webhook is active or not
string
Event type that triggers the webhook. Common values include ‘contact_change’ (for contact updates via API/forms) and ‘manual_change’ (for manual updates in the ActiveTrail UI).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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.

Input Parameters

string
Updated parameter name/key. For headers, use standard header names (e.g., ‘Authorization’, ‘X-API-Key’). For query params, use the query parameter name. For body params, use the JSON field name.
string
Updated parameter value when event_value_type is ‘custom_text’. When event_value_type is ‘user_field’, this field can be empty as the value comes from user_field.
string
Name of the contact field to use as the parameter value. Required when event_value_type is ‘user_field’. Common values: ‘email’, ‘first_name’, ‘last_name’, ‘phone’.
integer
required
The unique identifier of the webhook containing the parameter. Can be obtained from ‘Get Webhooks’ or ‘Create Webhook’ actions.
integer
required
The unique identifier of the parameter to update. Can be obtained from ‘Get Webhook Parameters’ action.
string
How the parameter value is determined. Valid values: ‘custom_text’ (use static value from ‘value’ field), ‘user_field’ (dynamically use contact field specified in ‘user_field’).
string
Where the parameter will be sent. Valid values: ‘header’ (HTTP header), ‘query’ (URL query parameter), ‘body’ (request body field).

Output

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