# ActiveTrail

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

- **Category:** email newsletters
- **Auth:** API_KEY
- **Composio Managed App Available?** N/A
- **Tools:** 160
- **Triggers:** 0
- **Slug:** `ACTIVE_TRAIL`
- **Version:** 20260312_00

## Tools

### Add Group Member

**Slug:** `ACTIVE_TRAIL_ADD_GROUP_MEMBER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fax` | string | No | Fax number |
| `city` | string | No | City name |
| `ext1` | string | No | Custom extension field 1 for additional contact data |
| `ext2` | string | No | Custom extension field 2 for additional contact data |
| `ext3` | string | No | Custom extension field 3 for additional contact data |
| `ext4` | string | No | Custom extension field 4 for additional contact data |
| `ext5` | string | No | Custom extension field 5 for additional contact data |
| `ext6` | string | No | Custom extension field 6 for additional contact data |
| `email` | string | Yes | Contact's email address (required) |
| `phone1` | string | No | Primary phone number (for SMS or calls) |
| `phone2` | string | No | Secondary phone number |
| `status` | string | No | Contact's subscription status in the group. Note: cannot import a contact in status 'subscribe' if they are inactive on ActiveTrail |
| `street` | string | No | Street address |
| `birthday` | string | No | Birthday date in YYYY-MM-DD format |
| `group_id` | integer | Yes | The unique identifier for the group to add the member to |
| `zip_code` | string | No | Postal/ZIP code |
| `last_name` | string | No | Contact's last name |
| `first_name` | string | No | Contact's first name |
| `anniversary` | string | No | Anniversary date in YYYY-MM-DD format |
| `campaign_id` | integer | No | Campaign identifier to associate with this member |
| `encryptedext1` | string | No | Encrypted custom field 1 for sensitive data |
| `encryptedext2` | string | No | Encrypted custom field 2 for sensitive data |
| `encryptedext3` | string | No | Encrypted custom field 3 for sensitive data |
| `encryptedext4` | string | No | Encrypted custom field 4 for sensitive data |
| `is_do_not_mail` | boolean | No | Flag to mark contacts who should not receive mail communications |
| `is_trigger_events` | boolean | No | Whether to trigger automation events when adding the member |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Mailing List Member

**Slug:** `ACTIVE_TRAIL_ADD_MAILINGLIST_MEMBER`

Tool to add a member to a mailing list in ActiveTrail. Creates a new contact or adds an existing contact to the specified mailing list and groups. Either email or SMS must be provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fax` | string | No | Fax number |
| `sms` | string | No | Contact SMS/mobile number (required if email is null) |
| `city` | string | No | City name |
| `ext1` | string | No | Custom extension field 1 for additional contact data |
| `ext2` | string | No | Custom extension field 2 for additional contact data |
| `ext3` | string | No | Custom extension field 3 for additional contact data |
| `ext4` | string | No | Custom extension field 4 for additional contact data |
| `ext5` | string | No | Custom extension field 5 for additional contact data |
| `ext6` | string | No | Custom extension field 6 for additional contact data |
| `ext7` | string | No | Custom extension field 7 for additional contact data |
| `ext8` | string | No | Custom extension field 8 for additional contact data |
| `ext9` | string | No | Custom extension field 9 for additional contact data |
| `num1` | string | No | Custom numeric field 1 |
| `num2` | string | No | Custom numeric field 2 |
| `num3` | string | No | Custom numeric field 3 |
| `num4` | string | No | Custom numeric field 4 |
| `num5` | string | No | Custom numeric field 5 |
| `date1` | string | No | Custom date field 1 |
| `date2` | string | No | Custom date field 2 |
| `date3` | string | No | Custom date field 3 |
| `date4` | string | No | Custom date field 4 |
| `date5` | string | No | Custom date field 5 |
| `email` | string | No | Contact email address (required if sms is null) |
| `ext10` | string | No | Custom extension field 10 for additional contact data |
| `ext11` | string | No | Custom extension field 11 for additional contact data |
| `ext12` | string | No | Custom extension field 12 for additional contact data |
| `ext13` | string | No | Custom extension field 13 for additional contact data |
| `ext14` | string | No | Custom extension field 14 for additional contact data |
| `ext15` | string | No | Custom extension field 15 for additional contact data |
| `ext16` | string | No | Custom extension field 16 for additional contact data |
| `ext17` | string | No | Custom extension field 17 for additional contact data |
| `ext18` | string | No | Custom extension field 18 for additional contact data |
| `ext19` | string | No | Custom extension field 19 for additional contact data |
| `ext20` | string | No | Custom extension field 20 for additional contact data |
| `ext21` | string | No | Custom extension field 21 for additional contact data |
| `ext22` | string | No | Custom extension field 22 for additional contact data |
| `ext23` | string | No | Custom extension field 23 for additional contact data |
| `ext24` | string | No | Custom extension field 24 for additional contact data |
| `ext25` | string | No | Custom extension field 25 for additional contact data |
| `phone1` | string | No | Primary phone number |
| `phone2` | string | No | Secondary phone number |
| `status` | string | No | Contact's subscription status |
| `street` | string | No | Street address |
| `birthday` | string | No | Birthday date |
| `zip_code` | string | No | Postal/ZIP code |
| `group_ids` | array | Yes | The groups' IDs the contacts will be added to (required) |
| `last_name` | string | No | Contact's last name |
| `first_name` | string | No | Contact's first name |
| `is_deleted` | boolean | No | Deletion status flag - set to true to mark contact as deleted |
| `sms_status` | string | No | SMS subscription status |
| `anniversary` | string | No | Anniversary date |
| `subscribe_ip` | string | No | IP address used for subscription |
| `mailinglist_id` | integer | Yes | The unique identifier for the mailing list to add the member to |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Growth

**Slug:** `ACTIVE_TRAIL_CONTACT_GROWTH`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | End date (YYYY-MM-DD format) for filtering contact growth data. If not provided, defaults to the current date. |
| `from_date` | string | No | Start date (YYYY-MM-DD format) for filtering contact growth data. If not provided, defaults to three months prior to the current date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create a New Group

**Slug:** `ACTIVE_TRAIL_CREATE_A_NEW_GROUP`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the group to create. This is the only required field. Must be unique within your account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Campaign

**Slug:** `ACTIVE_TRAIL_CREATE_CAMPAIGN`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Campaign for Contacts

**Slug:** `ACTIVE_TRAIL_CREATE_CAMPAIGN_FOR_CONTACTS`

Tool to create and send a new campaign to specific contacts in ActiveTrail. Use when you need to create campaigns targeted at selected recipients by contact IDs or email addresses. Supports regular campaigns, A/B split campaigns, and e-commerce campaigns.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign` | object | Yes | Campaign configuration object containing details, design, and optional template. Can be set as A/B split, E-commerce, or regular campaign. |
| `campaign_contacts` | object | Yes | Contact targeting information. Provide either contacts_ids or contacts_emails to specify recipients. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Contact

**Slug:** `ACTIVE_TRAIL_CREATE_CONTACT`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fax` | string | No | Fax number |
| `sms` | string | No | Contact's SMS phone number. Required if email is not provided |
| `city` | string | No | City name |
| `ext1` | string | No | Extended custom field 1 |
| `ext2` | string | No | Extended custom field 2 |
| `ext3` | string | No | Extended custom field 3 |
| `ext4` | string | No | Extended custom field 4 |
| `ext5` | string | No | Extended custom field 5 |
| `ext6` | string | No | Extended custom field 6 |
| `ext7` | string | No | Extended custom field 7 |
| `ext8` | string | No | Extended custom field 8 |
| `ext9` | string | No | Extended custom field 9 |
| `num1` | integer | No | Custom numeric field 1 |
| `num2` | integer | No | Custom numeric field 2 |
| `num3` | integer | No | Custom numeric field 3 |
| `num4` | integer | No | Custom numeric field 4 |
| `num5` | integer | No | Custom numeric field 5 |
| `date1` | string | No | Custom date field 1 |
| `date2` | string | No | Custom date field 2 |
| `date3` | string | No | Custom date field 3 |
| `date4` | string | No | Custom date field 4 |
| `date5` | string | No | Custom date field 5 |
| `email` | string | No | Contact's email address. Required if sms is not provided |
| `ext10` | string | No | Extended custom field 10 |
| `ext11` | string | No | Extended custom field 11 |
| `ext12` | string | No | Extended custom field 12 |
| `ext13` | string | No | Extended custom field 13 |
| `ext14` | string | No | Extended custom field 14 |
| `ext15` | string | No | Extended custom field 15 |
| `ext16` | string | No | Extended custom field 16 |
| `ext17` | string | No | Extended custom field 17 |
| `ext18` | string | No | Extended custom field 18 |
| `ext19` | string | No | Extended custom field 19 |
| `ext20` | string | No | Extended custom field 20 |
| `ext21` | string | No | Extended custom field 21 |
| `ext22` | string | No | Extended custom field 22 |
| `ext23` | string | No | Extended custom field 23 |
| `ext24` | string | No | Extended custom field 24 |
| `ext25` | string | No | Extended custom field 25 |
| `phone1` | string | No | Primary phone number |
| `phone2` | string | No | Secondary phone number |
| `street` | string | No | Street address |
| `birthday` | string | No | Contact's birth date |
| `zip_code` | string | No | Zip or postal code |
| `last_name` | string | No | Contact's last name |
| `first_name` | string | No | Contact's first name |
| `anniversary` | string | No | Anniversary date |
| `subscribe_ip` | string | No | IP address at subscription time |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Content Category

**Slug:** `ACTIVE_TRAIL_CREATE_CONTENT_CATEGORY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the content category to create |
| `is_default` | boolean | No | Whether this category should be set as the default category |
| `display_order` | integer | No | Display order for the category. Higher numbers appear later in the list |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create New Mailing List

**Slug:** `ACTIVE_TRAIL_CREATE_NEW_MAILING_LIST`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the mailing list. This is the only required field. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Order

**Slug:** `ACTIVE_TRAIL_CREATE_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `orders` | array | Yes | Array of order objects to create. At least one order is required. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Segmentation

**Slug:** `ACTIVE_TRAIL_CREATE_SEGMENTATION`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the segmentation. Must be unique within your account |
| `rules_segment` | object | Yes | Segmentation rules defining which contacts match this segment. Contains basic_rules_set and optional additional_rules_sets |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Smart Code Site

**Slug:** `ACTIVE_TRAIL_CREATE_SMART_CODE_SITE`

Creates 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SMS Campaign

**Slug:** `ACTIVE_TRAIL_CREATE_SMS_CAMPAIGN`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create SMS Operational Message

**Slug:** `ACTIVE_TRAIL_CREATE_SMS_OPERATIONAL_MESSAGE`

Tool to create a new operational SMS transactional message. Use when you need to create an SMS campaign for later use or editing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The SMS campaign name/title for internal use |
| `content` | string | Yes | The SMS message content/text to send |
| `from_name` | string | Yes | The sender identifier/name (max 11 English letters, no special characters or spaces) |
| `can_unsubscribe` | boolean | No | Whether unsubscription link is enabled |
| `unsubscribe_text` | string | No | Unsubscribe text shown in the message |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Webhook

**Slug:** `ACTIVE_TRAIL_CREATE_WEBHOOK`

Create a new webhook for event notifications in ActiveTrail. Webhooks enable real-time notifications for events like contact changes or campaign activities. After creating the webhook, use the 'Update Webhook Parameter' action to add custom parameters (headers, query params, body data) if needed.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | The URL that the webhook will call when triggered |
| `name` | string | Yes | The name of the webhook |
| `event_type` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete content category

**Slug:** `ACTIVE_TRAIL_DELETE_ACCOUNT_CONTENT_CATEGORIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the category to be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete group member

**Slug:** `ACTIVE_TRAIL_DELETE_A_MEMBER_IN_A_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | The unique identifier for the group |
| `contact_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Automations

**Slug:** `ACTIVE_TRAIL_DELETE_AUTOMATIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `ids` | string | Yes | Automation identifier(s). For single deletion, provide one ID. For bulk deletion, provide multiple IDs separated by commas (e.g., '1,2,3'). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Campaign

**Slug:** `ACTIVE_TRAIL_DELETE_CAMPAIGN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the campaign to be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Contact

**Slug:** `ACTIVE_TRAIL_DELETE_CONTACT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique contact ID (numeric string) to permanently delete from the ActiveTrail account |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete group by ID

**Slug:** `ACTIVE_TRAIL_DELETE_GROUP_BY_ID`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | integer | Yes | The unique identifier for the group to be deleted |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Mailing List

**Slug:** `ACTIVE_TRAIL_DELETE_MAILING_LIST`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the mailing list to be removed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Smart Code Site

**Slug:** `ACTIVE_TRAIL_DELETE_SMART_CODE_SITE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the Smart Code site to be removed |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Template

**Slug:** `ACTIVE_TRAIL_DELETE_TEMPLATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the template to delete |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete template category

**Slug:** `ACTIVE_TRAIL_DELETE_TEMPLATES_TEMPLATE_CATEGORY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the template category to be deleted. Note: Deleting a category will also delete all templates within it. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Webhook

**Slug:** `ACTIVE_TRAIL_DELETE_WEBHOOK`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the webhook to delete. Can be obtained from the 'Get Webhooks' endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete webhook parameter

**Slug:** `ACTIVE_TRAIL_DELETE_WEBHOOKS_PARAMETERS`

Removes 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | integer | Yes | The unique webhook identifier. Obtain this from the 'Get Webhooks' endpoint or from the webhook ID returned when creating a webhook. |
| `parameter_id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Balance

**Slug:** `ACTIVE_TRAIL_GET_ACCOUNT_BALANCE`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get specific content category

**Slug:** `ACTIVE_TRAIL_GET_ACCOUNT_CONTENT_CATEGORIES2`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the category to retrieve. Can be found using the endpoint to get the account's list of categories. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get ActiveCommerce Integration Data

**Slug:** `ACTIVE_TRAIL_GET_ACCOUNT_INTEGRATIONDATA`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Merge Status

**Slug:** `ACTIVE_TRAIL_GET_ACCOUNT_MERGE`

Check if the ActiveTrail account has any pending account merge operations. This action retrieves the current account merge status, indicating whether there are any account merges awaiting completion. Account merges are typically used when consolidating multiple ActiveTrail accounts into one. Returns information about pending merges including their status, source and target accounts, and creation dates. Use this when you need to: - Verify if any account merge operations are in progress - Monitor the status of account consolidation processes - Check for pending administrative merge tasks

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Campaign Reports

**Slug:** `ACTIVE_TRAIL_GET_ALL_CAMPAIGN_REPORTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination of results. If not provided, the API defaults to page 1. Range: 1 to 2147483647 |
| `limit` | integer | No | Number of results per page. If not provided, the API defaults to 20. Maximum: 100 |
| `to_date` | string | No | End date for filtering campaigns by last update date. If not provided, the API defaults to current date. Format: YYYY-MM-DD |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Groups

**Slug:** `ACTIVE_TRAIL_GET_ALL_GROUPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Range: 1-2147483647. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Maximum number of groups to return per page. Range: 1-100. Default: 100. |
| `search_term` | string | No | Group name to search for. Used to filter groups by name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get All Sent Campaigns

**Slug:** `ACTIVE_TRAIL_GET_ALL_SENT_CAMPAIGNS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation Log

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATION_LOG`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The automation ID for which to retrieve contact logs. This identifies the specific automation workflow whose contact journey logs you want to track. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation Queue Logs

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATION_REPORTS_LOG_AUTOMATION_QUEUE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The automation ID for which to retrieve queue logs. This identifies the specific automation workflow to query. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation SMS Campaign Summary Report

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATION_REPORTS_SMS_CAMPAIGN_SUMMARY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Automation id. Can be found using the endpoint 'Get account's automations' |
| `to_date` | string | No | End date for filtering SMS campaign reports. Format: YYYY-MM-DD or ISO 8601 date string. |
| `from_date` | string | No | Start date for filtering SMS campaign reports. Format: YYYY-MM-DD or ISO 8601 date string. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation Email Campaign Summary Report

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATION_REPORTS_SUMMARY_REPORT`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Automation id. Can be found using the endpoint 'Get account's automations' or in the UI |
| `to_date` | string | Yes | End date for report period. Format: YYYY-MM-DD |
| `from_date` | string | Yes | Start date for report period. Format: YYYY-MM-DD |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automations

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATIONS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination of results. Used to navigate through multiple pages of automations. |
| `limit` | integer | No | Maximum number of automation records to return per page. Controls the number of results returned in each request. |
| `state_type` | string | No | Filter automations by their operational status/state. Used to filter which automations to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation Details

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATIONS_DETAILS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Automation identifier. Can be found using the 'Get account's automations' endpoint or via the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation Email Campaign Steps

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATIONS_EMAIL_CAMPAIGN_STEPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation SMS Campaign Steps

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATIONS_SMS_CAMPAIGN_STEPS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation Trigger Types

**Slug:** `ACTIVE_TRAIL_GET_AUTOMATION_TRIGGER_TYPES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Bounces

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_BOUNCES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Campaign identifier. Can be found using the 'Get account's email campaigns' endpoint or in the UI. |
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of bounce results. |
| `limit` | integer | No | Number of bounce records to return per page. Controls the size of each page in paginated results. |
| `to_date` | string | No | End date for filtering bounce results. Format: YYYY-MM-DD. If not provided, defaults to current date. |
| `from_date` | string | No | Start date for filtering bounce results. Format: YYYY-MM-DD. If not provided, defaults to three months prior to current date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Click-Through Data

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_CLICKS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The campaign identifier for which to retrieve click-through data. Obtain campaign IDs using the 'Get All Campaign Reports' action. |
| `page` | integer | No | Page number for pagination (starting from 1). Use this to navigate through multiple pages of results. Defaults to 1 if not specified. |
| `limit` | integer | No | 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. |
| `link_id` | string | No | 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. |
| `to_date` | string | No | End date for filtering click data. Format: YYYY-MM-DD. If not specified, defaults to the current date. |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Design

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_DESIGN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the campaign. Can be found using 'Get account's email campaigns' endpoint or in the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Domains Report

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_DOMAINS_REPORT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Specific results page number for pagination. Range: 1-2147483647 |
| `limit` | integer | No | Number of results per page. Range: 1-100. Default: 20 |
| `to_date` | string | No | End date for filtering domain report data. Returns domain statistics up to this date. Format: YYYY-MM-DD |
| `from_date` | string | No | Start date for filtering domain report data. Returns domain statistics from this date onwards. Format: YYYY-MM-DD |
| `campaign_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Opens

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_OPENS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Specific results page number for pagination. Valid range: 1-2147483647. |
| `limit` | integer | No | Limit the number of items in the results. Valid range: 1-100. Defaults to 20 if not provided. |
| `groupid` | integer | No | Optional contact group identifier to filter openers from a specific group only. |
| `to_date` | string | No | Campaign update end date for filtering. Format: YYYY-MM-DD. If not provided, defaults to current date. |
| `from_date` | string | No | Campaign update start date for filtering. Format: YYYY-MM-DD. If not provided, defaults to three months prior to current date. |
| `campaign_id` | integer | Yes | Campaign identifier. Can be found using the 'Get account's email campaigns' endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Report

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_REPORT`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Campaign identifier to retrieve the report for. Obtainable via the 'Get All Campaign Reports' action or from the UI. |
| `page` | integer | No | Specific page number for pagination. Range: 1 to 2147483647. Default: 1. |
| `limit` | integer | No | Maximum number of results per page. Range: 1 to 100. Default: 20. |
| `to_date` | string | No | 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). |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Bounced Emails by Type

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_BOUNCED`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The campaign identifier for which to retrieve bounced email details. |
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Number of records to return per page. Controls the size of each page in paginated results. |
| `bounce_type` | string ("hard" | "soft") | No | Type of bounce to filter results. 'hard' for permanent delivery failures, 'soft' for temporary failures. If not provided, returns all bounce types. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Spam Complaints

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_COMPLAINTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Email Activity Report

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_EMAIL_ACTIVITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The campaign identifier for which to retrieve email activity details. |
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Number of records to return per page. Controls the size of each page in paginated results. Maximum: 100. |
| `to_date` | string | No | End date for filtering email activity. Format: YYYY-MM-DD. |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Sent Emails

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_SENT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Unopened Contacts

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_REPORTS_UNOPENED`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Scheduling

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_SCHEDULING`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign by ID

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_S_DETAILS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | Campaign identifier. Can be found using the endpoint 'Get account's email campaigns...' or in the UI |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Details

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGNS_DETAILS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Campaign identifier. Can be found using the 'Get account's email campaigns' endpoint or via the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Segment Settings

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGNS_SEGMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the campaign. Can be found using 'Get account's email campaigns' endpoint or in the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sent Campaigns

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGNS_SENT_CAMPAIGNS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Template

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_TEMPLATE`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Campaign Unsubscribed Contacts

**Slug:** `ACTIVE_TRAIL_GET_CAMPAIGN_UNSUBSCRIBED`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Campaign identifier. The unique ID of the campaign. Can be found via the 'Get account's email campaigns' endpoint or in the UI. |
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647. |
| `limit` | integer | No | 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. |
| `to_date` | string | No | 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. |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Commerce Schema

**Slug:** `ACTIVE_TRAIL_GET_COMMERCE_SCHEMA`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Activity

**Slug:** `ACTIVE_TRAIL_GET_CONTACT_ACTIVITY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Contact identifier. Can be found using the 'Get account's contacts list' endpoint |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Details

**Slug:** `ACTIVE_TRAIL_GET_CONTACT_DETAILS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Unique contact identifier. Can be obtained from the GET /api/contacts endpoint |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Fields

**Slug:** `ACTIVE_TRAIL_GET_CONTACT_FIELDS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields_type` | string | No | Filter contact fields by type. Used to filter which contact fields to retrieve from the account. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact Groups

**Slug:** `ACTIVE_TRAIL_GET_CONTACT_GROUPS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Contact ID to retrieve group memberships for. Can be found using the 'Get Contact List' action. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact List

**Slug:** `ACTIVE_TRAIL_GET_CONTACT_LIST`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact's Errors

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_ERRORS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique contact identifier to retrieve bounces for |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact's Mailing Lists

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_MAILINGLISTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Contact ID to retrieve mailing lists for. Can be found using the 'Get account's contacts list' endpoint. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts Merges

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_MERGES`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact SMS Statistics

**Slug:** `ACTIVE_TRAIL_GET_CONTACT_SMS_STATISTICS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | Contact identifier. The unique ID of the customer/contact whose SMS interaction statistics you want to retrieve |
| `message_id` | integer | Yes | Transactional SMS message identifier. The unique ID of the operational/transactional SMS sent to the contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contact's Statistics for Campaign

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_STATISTICS_CAMPAIGN`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Contact identifier. Can be found using the endpoint 'Get account's contacts list...' |
| `campaign_id` | integer | Yes | Campaign identifier. Located via the campaigns endpoint or in the UI under Emails section |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts Subscription All Contacts

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_ALL_CONTACTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts Subscription Status

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_CUSTOMERS_STATUS`

Get daily breakdown of contact status statistics over a date range. Returns counts of active, unsubscribed, bounced, quarantined, spam complaints, inactive, and user-requested removal contacts for each day in the specified period. Defaults to recent days when no date range is provided.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | End date for filtering contact status statistics. If not provided, defaults to the current date |
| `from_date` | string | No | Start date for filtering contact status statistics. If not provided, defaults to three months prior to the current date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts Subscription Subscribers

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_SUBSCRIBERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647. |
| `limit` | integer | No | 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. |
| `to_date` | string | No | 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. |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts Subscription Unsubscribers

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_SUBSCRIPTION_UNSUBSCRIBERS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647. |
| `limit` | integer | No | 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. |
| `to_date` | string | No | 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. |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts Unsubscribers SMS

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_UNSUBSCRIBERS_SMS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. Valid range: 1 to 2147483647. |
| `limit` | integer | No | 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. |
| `to_date` | string | No | 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. |
| `from_date` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Contacts With SMS State

**Slug:** `ACTIVE_TRAIL_GET_CONTACTS_WITH_SMS_STATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Number of contacts to return per page. Controls the size of each page in paginated results. |
| `to_date` | string | No | End date for filtering contacts by state change date. Format: YYYY-MM-DD. If not provided, defaults to three months back from current date. |
| `from_date` | string | No | Start date for filtering contacts by state change date. Format: YYYY-MM-DD. If not provided, defaults to three months back from current date. |
| `search_term` | string | No | Search term for filtering contacts. Use this to search for specific contacts by name, email, or other identifying information. |
| `customer_states` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Content Categories

**Slug:** `ACTIVE_TRAIL_GET_CONTENT_CATEGORIES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Customer Stats for Transactional Message

**Slug:** `ACTIVE_TRAIL_GET_CUSTOMER_STATS_FOR_TRANSACTIONAL_MESSAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | integer | Yes | Contact identifier. The unique ID of the customer/contact whose interaction statistics you want to retrieve |
| `transactional_id` | integer | Yes | Transactional message identifier. The unique ID of the operational/transactional message sent to the contact |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Executive Report

**Slug:** `ACTIVE_TRAIL_GET_EXECUTIVE_REPORT`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get External Schema

**Slug:** `ACTIVE_TRAIL_GET_EXTERNAL_SCHEMA`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Details

**Slug:** `ACTIVE_TRAIL_GET_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Group identifier. Can be found using the endpoint 'Get account's groups' or in the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Contents by ID

**Slug:** `ACTIVE_TRAIL_GET_GROUP_CONTENTS_BY_ID`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Range: 1-2147483647. Default: 0. |
| `limit` | integer | No | Number of results per page. Range: 1-100. Default: 100. Maximum limit is 100. |
| `to_date` | string | No | End date for state change filtering. ISO 8601 date format. Defaults to current date if not provided. |
| `group_id` | integer | Yes | The group identifier. Can be found using the 'Get All Groups' endpoint or in the UI. |
| `from_date` | string | No | Start date for state change filtering. ISO 8601 date format. Defaults to 3 months prior to current date if not provided. |
| `search_term` | string | No | Search filter for members by email or SMS. Note: plus signs not supported. |
| `customer_states` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Group Events

**Slug:** `ACTIVE_TRAIL_GET_GROUPS_EVENTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Group identifier. Can be found using the endpoint 'Get account's groups' or in the UI. |
| `event_type` | string | No | Filter by event type (e.g., opens, clicks, unsubscribes, etc.). If not provided, returns all event types. |
| `event_to_date` | string | No | Filter by event occurrence end date. Format: YYYY-MM-DD. |
| `created_to_date` | string | No | Filter by subscriber creation end date. Format: YYYY-MM-DD. |
| `event_from_date` | string | No | Filter by event occurrence start date. Format: YYYY-MM-DD. Default is 3 months back if not specified. |
| `created_from_date` | string | No | Filter by subscriber creation start date. Format: YYYY-MM-DD. Default is 3 months back if not specified. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Landing Pages

**Slug:** `ACTIVE_TRAIL_GET_LANDING_PAGES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Range: 1-2147483647. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Maximum number of landing pages to return per page. Range: 1-100. Default: 20. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mailing List

**Slug:** `ACTIVE_TRAIL_GET_MAILING_LIST`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Mailing list identifier. The unique ID of the mailing list to retrieve. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mailing List Members

**Slug:** `ACTIVE_TRAIL_GET_MAILING_LIST_MEMBERS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Mailing Lists

**Slug:** `ACTIVE_TRAIL_GET_MAILING_LISTS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Order

**Slug:** `ACTIVE_TRAIL_GET_ORDER`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order_id` | string | Yes | Unique identifier for the order to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Push Campaign Opens

**Slug:** `ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_OPENS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the push campaign to retrieve opens for. |
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Number of records to return per page. Controls the size of each page in paginated results. |
| `to_date` | string | No | End date for filtering results. Default: current date. Format: Date string (YYYY-MM-DD). |
| `from_date` | string | No | Start date for filtering results. Default: 3 months prior to current date. Format: Date string (YYYY-MM-DD). |
| `send_type` | string | No | 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. |
| `search_term` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Push Campaign Delivered Report

**Slug:** `ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_DELIVERED`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Push Campaign Failed Delivery Report

**Slug:** `ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_FAILED`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Push Campaign Reports

**Slug:** `ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORTS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination (1-based). Use this to navigate through multiple pages of results. If not specified, defaults to page 1. |
| `limit` | integer | No | Maximum number of campaigns to return per page. Controls page size for pagination. If not specified, defaults to 20 campaigns per page. |
| `to_date` | string | No | 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. |
| `from_date` | string | No | 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. |
| `send_type` | string | No | 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. |
| `search_term` | string | No | Search term to filter campaigns by name or other searchable text fields. Partial matches are supported. Leave empty to return all campaigns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Push Campaign Sent Report

**Slug:** `ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_SENT`

Tool to retrieve the list of contacts who were sent a specific push notification campaign, including contact details, device types, and sent timestamps. Use when you need to see the complete list of recipients for a push campaign with their delivery information. Supports filtering by date range (defaults to last 3 months), send type, and search terms. Returns paginated results with contact details for each recipient.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Push Campaign Report Summary

**Slug:** `ACTIVE_TRAIL_GET_PUSH_CAMPAIGN_REPORT_SUMMARY`

Tool 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Push Campaigns

**Slug:** `ACTIVE_TRAIL_GET_PUSH_CAMPAIGNS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | End date for filtering campaign results in ISO format (YYYY-MM-DD). Default is current date if not specified |
| `from_date` | string | No | Start date for filtering campaign results in ISO format (YYYY-MM-DD). Default is 6 months back if not specified |
| `page_size` | integer | No | Number of results per page |
| `campaign_id` | string | No | Filter results by specific campaign identifier |
| `filter_type` | string | No | Type of filter to apply to campaign results |
| `page_number` | integer | No | Page number for pagination |
| `search_term` | string | No | Search term to filter campaigns by name or content |
| `include_deleted` | boolean | No | Whether to include deleted campaigns in results |
| `include_not_sent` | boolean | No | Whether to include unsent campaigns in results |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segmentation Rule Field Types

**Slug:** `ACTIVE_TRAIL_GET_SEGMENTATION_RULE_FIELD_TYPES`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segmentation Rule Operations

**Slug:** `ACTIVE_TRAIL_GET_SEGMENTATION_RULE_OPERATIONS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segmentation Rule Types

**Slug:** `ACTIVE_TRAIL_GET_SEGMENTATION_RULE_TYPES`

Tool to retrieve available segmentation rule types for automation. Returns a list of rule type names that can be used when creating or editing automation segmentations. Use this to discover what types of rules are available (e.g., Info, Numeric, Date, Group, Action, Order-related, Cart, Catalog, etc.).

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segmentation Rule Types Mapping

**Slug:** `ACTIVE_TRAIL_GET_SEGMENTATION_RULE_TYPES_MAPPING`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Segmentations

**Slug:** `ACTIVE_TRAIL_GET_SEGMENTATIONS`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Sending Profiles

**Slug:** `ACTIVE_TRAIL_GET_SENDING_PROFILES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Signup Forms

**Slug:** `ACTIVE_TRAIL_GET_SIGNUP_FORMS`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Smart Code Sites

**Slug:** `ACTIVE_TRAIL_GET_SMART_CODE_SITES`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign by ID

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | SMS campaign identifier. Can be found using the endpoint 'Get account's SMS campaigns' or in the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Clickers

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_CLICKERS`

Retrieve 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Delivered Report

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_DELIVERED`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Estimate

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_ESTIMATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Report

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT`

Tool to retrieve summary report for a specific SMS campaign by ID. Use when you need detailed metrics about an SMS campaign's performance including sent count, delivery rate, clicks, and errors.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | SMS campaign ID. Can be found using the endpoint 'Get account's SMS campaigns' or in the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Report Clicks

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_CLICKS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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. |
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Number of records to return per page. Controls the size of each page in paginated results. |
| `to_date` | string | No | End date for filtering click reports. Format: YYYY-MM-DD. |
| `from_date` | string | No | Start date for filtering click reports. Format: YYYY-MM-DD. |
| `send_type` | string | No | Filter by send type (immediate, scheduled, etc.). |
| `search_term` | string | No | Search criteria for filtering click results. |
| `rows_affected` | integer | No | Maximum number of rows to return in the result set. Use for pagination to limit results per request. |
| `previous_row_count` | integer | No | Offset for pagination - number of rows to skip before starting to return results. Used with rows_affected for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Failed Delivery Report

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_FAILED`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Reports

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORTS`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Sent Contacts Report

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_SENT`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Report Summary

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_SUMMARY`

Retrieve 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to_date` | string | No | End date for filtering campaigns to include in aggregation. Default: current date. Format: YYYY-MM-DD. |
| `from_date` | string | No | Start date for filtering campaigns to include in aggregation. Default: 3 months prior to current date. Format: YYYY-MM-DD. |
| `send_type` | string | No | 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). |
| `search_term` | string | No | Filter aggregate metrics by campaign name or other searchable fields. Only campaigns matching this search term will be included in the aggregated totals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Campaign Unsubscribed Contacts

**Slug:** `ACTIVE_TRAIL_GET_SMS_CAMPAIGN_REPORT_UNSUBSCRIBED`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | 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. |
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Number of records to return per page. Controls the size of each page in paginated results. |
| `to_date` | string | No | End date for filtering unsubscribe reports. Format: YYYY-MM-DD. Defaults to current date if not specified. |
| `from_date` | string | No | Start date for filtering unsubscribe reports. Format: YYYY-MM-DD. Defaults to 3 months prior if not specified. |
| `send_type` | string | No | Filter by send type (e.g., immediate, scheduled). Use to narrow down results by how the campaign was sent. |
| `search_term` | string | No | Search term to filter unsubscribed contacts by name, phone number, or other contact fields. |
| `rows_affected` | integer | No | Number of rows affected in the result set for pagination purposes. |
| `previous_row_count` | integer | No | Previous row count for pagination purposes. Used to track position when paginating through results. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get SMS Sending Profiles

**Slug:** `ACTIVE_TRAIL_GET_SMS_SENDING_PROFILES`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template

**Slug:** `ACTIVE_TRAIL_GET_TEMPLATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Template identifier. Can be obtained from the 'Get Templates' action (ACTIVE_TRAIL_GET_TEMPLATES) or from the template URL in the ActiveTrail UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template Content

**Slug:** `ACTIVE_TRAIL_GET_TEMPLATE_CONTENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the template. Can be found using 'Get Templates' endpoint or in the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Templates

**Slug:** `ACTIVE_TRAIL_GET_TEMPLATES`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Template Categories

**Slug:** `ACTIVE_TRAIL_GET_TEMPLATES_TEMPLATE_CATEGORY`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transactional Messages Classification

**Slug:** `ACTIVE_TRAIL_GET_TRANSACTIONAL_MESSAGES_CLASSIFICATION`

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Transactional SMS Message

**Slug:** `ACTIVE_TRAIL_GET_TRANSACTIONAL_SMS_MESSAGE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `transactional_sms_id` | integer | Yes | Transactional SMS message identifier. The unique ID of the operational SMS message to retrieve |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Two-Way SMS Replies

**Slug:** `ACTIVE_TRAIL_GET_TWO_WAY_SMS_REPLIES`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Automation Update Actions

**Slug:** `ACTIVE_TRAIL_GET_UPDATE_ACTIONS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User Social Accounts

**Slug:** `ACTIVE_TRAIL_GET_USER_SOCIAL_ACCOUNTS_GET`

Retrieve social media accounts (Facebook, Instagram, etc.) connected to the ActiveTrail account. Returns a list of connected social media accounts with details like platform, username, status, and connection date. Note: Social media integration is only available for ActiveTrail Plus plan customers.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook by ID

**Slug:** `ACTIVE_TRAIL_GET_WEBHOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | integer | Yes | The unique identifier of the webhook to retrieve. Can be found using the 'Get Webhooks' endpoint or in the UI. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhooks

**Slug:** `ACTIVE_TRAIL_GET_WEBHOOKS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `event_type` | string | No | 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. |
| `state_type` | string | No | Filter webhooks by state type. Used to retrieve webhooks based on their operational status (e.g., active, inactive). |
| `target_type` | string | No | Filter webhooks by target type. Used to retrieve webhooks based on their target configuration. |
| `is_ignore_parameters` | boolean | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Webhook Parameters

**Slug:** `ACTIVE_TRAIL_GET_WEBHOOKS_PARAMETERS`

Retrieves 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook_id` | integer | Yes | Webhook identifier. Obtain this by calling 'Get Webhooks' or 'Get Webhook by ID' actions first. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Import New Contacts

**Slug:** `ACTIVE_TRAIL_IMPORT_NEW_CONTACTS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group` | integer | Yes | Group identifier for contact assignment (required). Find using 'Get account's groups' endpoint or via UI: Contacts→Groups→click group name→check URL |
| `contacts` | array | Yes | Array of contact objects to import. Maximum 1000 contacts per request. |
| `mailing_list` | integer | No | Mailing list identifier (optional). Locate via 'Get account's mailing lists' endpoint or UI path: Contacts→Mailing Lists→click list name→view URL |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List SMS Campaigns

**Slug:** `ACTIVE_TRAIL_LIST_SMS_CAMPAIGNS`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Default is 1 |
| `limit` | integer | No | Number of results per page. Default is 20 |
| `to_date` | string | No | 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 |
| `from_date` | string | No | 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 |
| `filter_type` | string | No | Filter campaigns by type/status |
| `search_term` | string | No | Search campaigns by name or content |
| `is_include_not_sent` | boolean | No | Include campaigns that have not yet been sent |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Transactional SMS Messages

**Slug:** `ACTIVE_TRAIL_LIST_TRANSACTIONAL_SMS_MESSAGES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `page` | integer | No | Page number for pagination. Use this to navigate through multiple pages of results. |
| `limit` | integer | No | Maximum number of results to return per page. Controls the page size for pagination. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Campaign from Template

**Slug:** `ACTIVE_TRAIL_POST_TEMPLATES_CAMPAIGN`

Creates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template_id` | integer | Yes | The unique identifier of the template to use for campaign creation. Can be obtained from the 'Get Templates' action. |
| `campaign_details` | object | Yes | Campaign details including name, subject, and user profile ID |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Template Category

**Slug:** `ACTIVE_TRAIL_POST_TEMPLATES_TEMPLATE_CATEGORY`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | The name of the template category to create. This is a required field. |
| `name_key` | string | No | Optional name key identifier. Can be deleted in a post/put endpoints. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Add Webhook Parameter

**Slug:** `ACTIVE_TRAIL_POST_WEBHOOKS_PARAMETERS`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | Yes | 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. |
| `value` | string | Yes | 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. |
| `user_field` | string | No | 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'. |
| `webhook_id` | integer | Yes | The unique identifier of the webhook to add a parameter to. Can be obtained from 'Get Webhooks' or 'Create Webhook' actions. |
| `event_value_type` | string | Yes | 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'). |
| `event_parameter_type` | string | Yes | Where the parameter will be sent. Valid values: 'header' (HTTP header), 'query' (URL query parameter), 'body' (request body field). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Test Webhook Request

**Slug:** `ACTIVE_TRAIL_POST_WEBHOOKS_TEST2`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `url` | string | Yes | Target webhook endpoint URL to receive the test request |
| `format` | integer | Yes | Response format identifier |
| `user_id` | integer | No | User identifier |
| `event_type` | string | Yes | Event type for the webhook test (e.g., 'contact_change') |
| `parameters` | array | No | Collection of key-value pairs with event parameter type for custom headers or body parameters |
| `target_type` | string | Yes | Target type for the webhook (e.g., 'zapier', 'custom') |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update content category

**Slug:** `ACTIVE_TRAIL_PUT_ACCOUNT_CONTENT_CATEGORIES`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the category to update. Obtain this from the 'Get Content Categories' or 'Get specific content category' action. |
| `name` | string | Yes | The new name for the category |
| `display_order` | integer | Yes | The display order for the category (determines the position in lists) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign Segment Settings

**Slug:** `ACTIVE_TRAIL_PUT_CAMPAIGNS_SEGMENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Campaign identifier. Only draft campaigns can be updated. |
| `group_ids` | array | Yes | List of group IDs to target for the campaign. These groups will receive the campaign. |
| `restricted_group_ids` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove Contact from Mailing List

**Slug:** `ACTIVE_TRAIL_REMOVE_A_CONTACT_FROM_A_MAILING_LIST`

Removes a specific contact from a mailing list in ActiveTrail. Use this action to unsubscribe or remove a contact from a particular mailing list without deleting the contact from your account entirely. The contact will no longer receive campaigns sent to this specific mailing list, but will remain in other lists they belong to. Note: This is a destructive operation that cannot be undone via API. To re-add the contact to the list, use the 'Import New Contacts' action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contact_id` | string | Yes | 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 |
| `mailinglist_id` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Remove external contacts from group

**Slug:** `ACTIVE_TRAIL_REMOVE_EXTERNAL_CONTACT_FROM_GROUP`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_id` | string | Yes | The unique identifier for the group from which contacts will be removed |
| `external_contacts` | array | Yes | List of external contacts to remove from the group. Each contact requires both externalId and externalName to match. Maximum 1000 contacts per call. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Operational Message

**Slug:** `ACTIVE_TRAIL_SEND_OPERATIONAL_MESSAGE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bcc` | object | No | BCC (Blind Carbon Copy) email addresses configuration. |
| `design` | object | Yes | Email design configuration including HTML content, language type, and body format (required) |
| `details` | object | Yes | Message metadata including name, subject, classification, and sender name (required) |
| `email_package` | array | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Send Operational Message Email

**Slug:** `ACTIVE_TRAIL_SEND_OPERATIONAL_MESSAGE_EMAIL`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bcc` | object | No | BCC email configuration. |
| `design` | object | Yes | Email design configuration. Either provide content (HTML) or template_id. |
| `details` | object | Yes | Message configuration including name, subject, and classification |
| `email_package` | array | Yes | Array of email recipients (maximum 500 recipients per request) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Test Webhook

**Slug:** `ACTIVE_TRAIL_TEST_WEBHOOK`

Send 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign

**Slug:** `ACTIVE_TRAIL_UPDATE_CAMPAIGN`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The campaign identifier (used in URL path) |
| `design` | object | Yes | Campaign design configuration containing HTML content and formatting options |
| `details` | object | Yes | Campaign details object containing name, subject, and configuration |
| `send_test` | string | No | Comma-separated list of email addresses for test emails |
| `send_type` | string | No | Campaign sending type. 'Regular' for standard email campaigns, 'Empty' for campaigns without recipients initially. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign Design

**Slug:** `ACTIVE_TRAIL_UPDATE_CAMPAIGN_DESIGN`

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

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign Scheduling

**Slug:** `ACTIVE_TRAIL_UPDATE_CAMPAIGN_SCHEDULING`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Campaign identifier. Can be found using the 'Get account's email campaigns' endpoint or from the campaign preview URL in the UI |
| `is_sent` | boolean | Yes | Flag indicating whether the campaign should be dispatched |
| `scheduled_date_utc` | string | Yes | Planned send date/time in UTC format (e.g., '2016-12-24T14:12:12'). Cannot be set to a past date |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign Details

**Slug:** `ACTIVE_TRAIL_UPDATE_CAMPAIGN_S_DETAILS`

Updates 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

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Campaign Template

**Slug:** `ACTIVE_TRAIL_UPDATE_CAMPAIGN_TEMPLATE`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign_id` | integer | Yes | The unique identifier of the campaign whose template should be updated. Only campaigns in draft mode can be updated. |
| `template_id` | integer | Yes | The unique identifier of the template to assign to the campaign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Contact

**Slug:** `ACTIVE_TRAIL_UPDATE_CONTACT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Contact ID to update. Can be found using the 'Get account's contacts list' endpoint |
| `fax` | string | No | Fax number |
| `sms` | string | No | Contact's SMS/phone number. Either email or sms must be provided |
| `city` | string | No | City |
| `ext1` | string | No | Custom extension field 1 |
| `ext2` | string | No | Custom extension field 2 |
| `ext3` | string | No | Custom extension field 3 |
| `ext4` | string | No | Custom extension field 4 |
| `ext5` | string | No | Custom extension field 5 |
| `ext6` | string | No | Custom extension field 6 |
| `ext7` | string | No | Custom extension field 7 |
| `ext8` | string | No | Custom extension field 8 |
| `ext9` | string | No | Custom extension field 9 |
| `num1` | integer | No | Custom numeric field 1 |
| `num2` | integer | No | Custom numeric field 2 |
| `num3` | integer | No | Custom numeric field 3 |
| `num4` | integer | No | Custom numeric field 4 |
| `num5` | integer | No | Custom numeric field 5 |
| `date1` | string | No | Custom date field 1 |
| `date2` | string | No | Custom date field 2 |
| `date3` | string | No | Custom date field 3 |
| `date4` | string | No | Custom date field 4 |
| `date5` | string | No | Custom date field 5 |
| `email` | string | No | Contact's email address. Either email or sms must be provided |
| `ext10` | string | No | Custom extension field 10 |
| `ext11` | string | No | Custom extension field 11 |
| `ext12` | string | No | Custom extension field 12 |
| `ext13` | string | No | Custom extension field 13 |
| `ext14` | string | No | Custom extension field 14 |
| `ext15` | string | No | Custom extension field 15 |
| `ext16` | string | No | Custom extension field 16 |
| `ext17` | string | No | Custom extension field 17 |
| `ext18` | string | No | Custom extension field 18 |
| `ext19` | string | No | Custom extension field 19 |
| `ext20` | string | No | Custom extension field 20 |
| `ext21` | string | No | Custom extension field 21 |
| `ext22` | string | No | Custom extension field 22 |
| `ext23` | string | No | Custom extension field 23 |
| `ext24` | string | No | Custom extension field 24 |
| `ext25` | string | No | Custom extension field 25 |
| `phone1` | string | No | Primary phone number |
| `phone2` | string | No | Secondary phone number |
| `status` | string | No | Contact status |
| `street` | string | No | Street address |
| `birthday` | string | No | Birthday date |
| `zip_code` | string | No | Postal/ZIP code |
| `last_name` | string | No | Last name |
| `first_name` | string | No | First name |
| `is_deleted` | boolean | No | If true - contact will be deleted. If false - contact will be restored if previously deleted |
| `sms_status` | string | No | SMS contact status |
| `anniversary` | string | No | Anniversary date |
| `subscribe_ip` | string | No | The Subscribe IP address |
| `double_opt_in_config` | object | No | Configuration for double opt-in email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Group

**Slug:** `ACTIVE_TRAIL_UPDATE_GROUP`

Updates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the group to update. Can be found using the 'Get All Groups' or 'Get Group by ID' actions. |
| `name` | string | No | New name for the group. This is the primary field you should update. Must be a non-empty string if provided. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Order

**Slug:** `ACTIVE_TRAIL_UPDATE_ORDER`

Updates an existing order in the ActiveTrail commerce system. Use this action to modify order details including customer information (name, email, phone), shipping address, order status, pricing (amounts, tax, currency), or product items. You must provide the existing order_id - this action cannot create new orders. Common use cases: - Update order status (e.g., from "pending" to "shipped") - Modify customer contact information - Adjust pricing or add/remove items - Update shipping addresses - Change order metadata (dates, custom fields)

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tax` | number | No | Total tax amount applied to this order (VAT, sales tax, etc.) |
| `city` | string | No | Shipping address city name |
| `email` | string | No | Customer's email address for order communications and receipts |
| `items` | array | No | List of products/items included in this order. Each item can have quantity, price, and product details |
| `mobile` | string | No | Customer's mobile phone number (include country code for international numbers) |
| `status` | string | No | Current order fulfillment status. Common values: pending, processing, completed, shipped, cancelled, refunded |
| `address` | string | No | Customer's shipping street address (number and street name) |
| `orderId` | string | No | 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 |
| `currency` | string | No | Three-letter ISO 4217 currency code for all monetary amounts in this order |
| `lastName` | string | No | Customer's last (family) name |
| `order_id` | string | Yes | Unique identifier for the order to update. This value is used in the API URL path (e.g., /commerce/Order/{order_id}) |
| `firstName` | string | No | Customer's first (given) name |
| `netAmount` | number | No | Subtotal amount before tax is applied (sum of item prices minus discounts) |
| `orderName` | string | No | Custom display name or reference label for this order (for internal tracking) |
| `totalPrice` | number | No | Total order price before tax (deprecated: use totalAmount instead) |
| `totalAmount` | number | No | Final grand total amount (netAmount + tax + any additional fees) |
| `purchaseDate` | string | No | Date and time when the order was placed. Format: ISO 8601 (YYYY-MM-DDTHH:MM:SS with optional timezone) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Segmentation

**Slug:** `ACTIVE_TRAIL_UPDATE_SEGMENTATION`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The segmentation identifier to be updated. Can be found using the 'Get Segmentations' action |
| `name` | string | No | Updated name for the segmentation. If not provided, the name remains unchanged |
| `rules_segment` | object | No | Complete segmentation rules structure containing all rule sets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Smart Code Site

**Slug:** `ACTIVE_TRAIL_UPDATE_SMART_CODE_SITE`

Updates 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the Smart Code site to update (used in URL path) |
| `name` | string | Yes | The updated name for the Smart Code site |
| `domains` | string | Yes | Comma-separated list of domains associated with the Smart Code site (required even for updates) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update SMS Operational Message

**Slug:** `ACTIVE_TRAIL_UPDATE_SMS_OPERATIONAL_MESSAGE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Operational SMS message ID to update. Can be found in the UI (go to Mobile -> SMS -> SMS list -> filter by 'Transactional SMS') |
| `name` | string | Yes | The SMS campaign name/title for internal use |
| `content` | string | Yes | The SMS message content/text to send |
| `from_name` | string | Yes | The sender identifier/name (max 11 English letters, no special characters or spaces) |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template

**Slug:** `ACTIVE_TRAIL_UPDATE_TEMPLATE`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The unique identifier of the template to update |
| `name` | string | No | Template name. Update this to change the template's display name. |
| `content` | string | No | HTML or text content of the template. Update this to change the template's body content. |
| `subject` | string | No | Email subject line. Update this to change the default subject for emails using this template. |
| `editor_type` | string | No | 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. |
| `AddPrintButton` | boolean | No | Whether to add a print button to the email template. When true, recipients can print the email directly from their email client. |
| `campaign_encoding` | integer | No | 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). |
| `template_category_id` | integer | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template Category

**Slug:** `ACTIVE_TRAIL_UPDATE_TEMPLATE_CATEGORY`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Category ID. Can be found using the endpoint 'Get my templates categories'. |
| `name` | string | Yes | The category's name |
| `name_key` | string | No | Optional; can be removed in POST/PUT requests |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Template Content

**Slug:** `ACTIVE_TRAIL_UPDATE_TEMPLATE_CONTENT`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | The unique identifier of the template to update |
| `content` | string | Yes | The HTML content for the template. This field contains the email template's HTML design/layout. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook

**Slug:** `ACTIVE_TRAIL_UPDATE_WEBHOOK`

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

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | The webhook ID to update. Can be found using the GET /api/webhooks endpoint. |
| `url` | string | Yes | The target URL that the webhook will call. Must be a full URL including http:// or https:// |
| `name` | string | Yes | The name of the webhook |
| `format` | string | No | Webhook format specification. Can be a string like 'json' or 'xml', or an integer code. |
| `typeid` | integer | No | Webhook type ID for the API. Defaults to 1 if not provided. Use 1 for standard webhooks. |
| `stateid` | integer | No | Webhook state ID for the API. Defaults to 10 if not provided. Use 10 for active webhooks. |
| `is_active` | boolean | No | Indicates whether the webhook is active or not |
| `event_type` | string | No | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Webhook Parameter

**Slug:** `ACTIVE_TRAIL_UPDATE_WEBHOOK_PARAMETER`

Tool 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key` | string | No | 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. |
| `value` | string | No | 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. |
| `user_field` | string | No | 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'. |
| `webhook_id` | integer | Yes | The unique identifier of the webhook containing the parameter. Can be obtained from 'Get Webhooks' or 'Create Webhook' actions. |
| `parameter_id` | integer | Yes | The unique identifier of the parameter to update. Can be obtained from 'Get Webhook Parameters' action. |
| `event_value_type` | string | No | 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'). |
| `event_parameter_type` | string | No | Where the parameter will be sent. Valid values: 'header' (HTTP header), 'query' (URL query parameter), 'body' (request body field). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |