The ActiveTrail connector lets your AI agent act in each user's ActiveTrail account. Each user connects their own ActiveTrail API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 60 tools.
- Tools
- 60
- What they doRead · write · destructive
- 38 · 15 · 738 read15 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the ActiveTrail connection
In AgentKit > Connections, create an ActiveTrail connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'activetrail'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize ActiveTrail:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'activetrail_account_balance_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "activetrail"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize ActiveTrail:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="activetrail_account_balance_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their ActiveTrail credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolactivetrail_account_balance_getGet the email and SMS credit balance of the ActiveTrail account.Read-onlyGet Account Balance
Get the email and SMS credit balance of the ActiveTrail account. Returns the remaining email and SMS credits. Use this before sending large campaigns.
Inputs
This tool takes no inputs.
activetrail_automation_activation_getGet whether an ActiveTrail automation is published (active).Read-onlyGet Automation Activation
Get whether an ActiveTrail automation is published (active). Returns is_published and any scheduled activation time. Use this before activating or pausing it.
Inputs
automation_idintegerrequired- Automation ID, from activetrail_automations_list. Example: 7788.
activetrail_automation_getGet the details of an ActiveTrail automation, without its steps.Read-onlyGet Automation
Get the details of an ActiveTrail automation, without its steps. Returns the automation's name, state, trigger and settings. Use this for an automation's details.
Inputs
automation_idintegerrequired- Automation ID, from activetrail_automations_list. Example: 7788.
activetrail_automation_summary_report_getGet the summary report of the email campaigns inside an ActiveTrail automation.Read-onlyGet Automation Summary Report
Get the summary report of the email campaigns inside an ActiveTrail automation. Returns per-email sent, opens, clicks, bounces and unsubscribes. Use this to measure an automation.
Inputs
automation_idintegerrequired- Automation ID, from activetrail_automations_list. Example: 7788.
botsboolean- True includes opens and clicks detected as bots. Example: false.
from_datestring- Start date, YYYY-MM-DD. Example: 2026-10-01.
to_datestring- End date, YYYY-MM-DD. Example: 2026-10-31.
activetrail_automations_listList the automations of the ActiveTrail account, optionally by state.Read-onlyList Automations
List the automations of the ActiveTrail account, optionally by state. Returns automations with ID, name, state and dates. Use this to find automation IDs.
Inputs
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
state_typeinteger- State filter: 5 untitled, 10 draft, 15 paused, 20 published, 30 deleted. Example: 20.one of
510152030
activetrail_campaign_getGet one ActiveTrail email campaign with its details, design, segment and scheduling.Read-onlyGet Email Campaign
Get one ActiveTrail email campaign with its details, design, segment and scheduling. Returns the full campaign. Use this to inspect a campaign. Use activetrail_campaign_report_get for its results.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
activetrail_campaign_report_activity_listList every contact's activity on an ActiveTrail email campaign.Read-onlyList Campaign Email Activity
List every contact's activity on an ActiveTrail email campaign. Returns per-contact sent, open, click, bounce and unsubscribe flags. Use this for a full per-contact export of one campaign.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_campaign_report_bounces_listList the bounces of an ActiveTrail email campaign and the bounce count per domain.Read-onlyList Campaign Bounces
List the bounces of an ActiveTrail email campaign and the bounce count per domain. Returns bounced contacts with bounce type and per-domain totals. Use this to clean bad addresses.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_campaign_report_clicks_listList the link clicks of an ActiveTrail email campaign.Read-onlyList Campaign Clicks
List the link clicks of an ActiveTrail email campaign. Returns links with click counts and the contacts who clicked. Use this to see which links worked.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_campaign_report_getGet the overview report of one ActiveTrail email campaign.Read-onlyGet Email Campaign Report
Get the overview report of one ActiveTrail email campaign. Returns sent, opens, clicks, bounces, unsubscribes and complaints with rates. Use this for one campaign's results. Use the campaign_report_* tools for the contacts behind each number.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_campaign_report_opens_listList the contacts who opened an ActiveTrail email campaign, optionally from one group.Read-onlyList Campaign Openers
List the contacts who opened an ActiveTrail email campaign, optionally from one group. Returns openers with email, name and open time. Use this to follow up with engaged contacts.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
group_idinteger- Only openers from this group. Example: 45678.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_campaign_report_sent_listList the contacts an ActiveTrail email campaign was sent to, optionally from one group.Read-onlyList Campaign Recipients
List the contacts an ActiveTrail email campaign was sent to, optionally from one group. Returns recipients with email and send time. Use this to see who received a campaign.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
group_idinteger- Only recipients from this group. Example: 45678.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_campaign_report_unsubscribed_listList the contacts who unsubscribed from an ActiveTrail email campaign.Read-onlyList Campaign Unsubscribes
List the contacts who unsubscribed from an ActiveTrail email campaign. Returns contacts with email and unsubscribe time. Use this to sync opt-outs from one campaign.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_campaign_reports_listList report summaries of ActiveTrail email campaigns: send date, opens, clicks, click-to-open, bounces, unsubscribes, complaints and unopened.Read-onlyList Email Campaign Reports
List report summaries of ActiveTrail email campaigns: send date, opens, clicks, click-to-open, bounces, unsubscribes, complaints and unopened. Returns one row per campaign. Use this to compare campaigns. Use activetrail_campaign_report_get for one campaign.
Inputs
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_campaign_scheduling_getGet when an ActiveTrail email campaign is or was sent.Read-onlyGet Email Campaign Schedule
Get when an ActiveTrail email campaign is or was sent. Returns is_sent and the scheduled UTC date. Use this to check a campaign's send time.
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
activetrail_contact_activity_listList an ActiveTrail contact's activity on the emails sent to them.Read-onlyList Contact Activity
List an ActiveTrail contact's activity on the emails sent to them. Returns campaigns with sent, open, click, bounce and unsubscribe events. Use this to see how a contact engages.
Inputs
contact_idintegerrequired- Contact ID, from activetrail_contacts_list. Example: 123456.
activetrail_contact_fields_listList the contact fields of the ActiveTrail account, including what each custom ext field is used for.Read-onlyList Contact Fields
List the contact fields of the ActiveTrail account, including what each custom ext field is used for. Returns fields with name, display name and type. Use this to map custom data to ext1..ext25 before creating contacts.
Inputs
fields_typeinteger- Only fields of this type: 1 text, 2 number, 3 boolean, 4 date, 5 email, 6 mobile, 7 contact and order. Example: 1.one of
1234567
activetrail_contact_getGet one ActiveTrail contact.Read-onlyGet Contact
Get one ActiveTrail contact. Returns the contact's email, mobile, name, statuses, dates and custom fields. Use this for a contact's details. Use activetrail_contact_activity_list for their email activity.
Inputs
contact_idintegerrequired- Contact ID, from activetrail_contacts_list. Example: 123456.
activetrail_contact_groups_listList the groups an ActiveTrail contact belongs to.Read-onlyList Contact Groups
List the groups an ActiveTrail contact belongs to. Returns groups with ID and name. Use this to check a contact's group memberships.
Inputs
contact_idintegerrequired- Contact ID, from activetrail_contacts_list. Example: 123456.
activetrail_contact_mailing_lists_listList the mailing lists an ActiveTrail contact belongs to.Read-onlyList Contact Mailing Lists
List the mailing lists an ActiveTrail contact belongs to. Returns mailing lists with ID and name. Use this to check a contact's mailing list memberships.
Inputs
contact_idintegerrequired- Contact ID, from activetrail_contacts_list. Example: 123456.
activetrail_contacts_listList the contacts of the ActiveTrail account, filtered by status, search text or status-change dates.Read-onlyList Contacts
List the contacts of the ActiveTrail account, filtered by status, search text or status-change dates. Returns contacts with ID, email, mobile, name, statuses and fields. Use this to find contacts. Use activetrail_contact_get for one contact.
Inputs
customer_statesinteger- Contact status filter as a number: -1 all, -2 active, -3 inactive, 1 unsubscribed by request, 2 bounced, 3 spam complaint, 4 quarantined. Example: -2.one of
-1-2-31234 from_datestring- Start of the status change date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
search_termstring- Email or mobile number to search for (emails containing + cannot be searched). Example: jane@example.com.
to_datestring- End of the status change date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_group_getGet one ActiveTrail group.Read-onlyGet Group
Get one ActiveTrail group. Returns the group with name, active and total contact counts and dates. Use this for a group's details.
Inputs
group_idintegerrequired- Group ID, from activetrail_groups_list or the group's URL in ActiveTrail (Contacts > Groups). Example: 45678.
activetrail_group_members_listList the contacts in an ActiveTrail group, filtered by status, search text or status-change dates.Read-onlyList Group Members
List the contacts in an ActiveTrail group, filtered by status, search text or status-change dates. Returns contacts with ID, email, mobile, name and statuses. Use this to read a group. Use activetrail_contacts_list for the whole account.
Inputs
group_idintegerrequired- Group ID, from activetrail_groups_list or the group's URL in ActiveTrail (Contacts > Groups). Example: 45678.
customer_statesinteger- Contact status filter as a number: -1 all, -2 active, -3 inactive, 1 unsubscribed by request, 2 bounced, 3 spam complaint, 4 quarantined. Example: -2.one of
-1-2-31234 from_datestring- Start of the status change date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
search_termstring- Email or mobile number to search for. Example: jane@example.com.
to_datestring- End of the status change date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_groups_listList the contact groups of the ActiveTrail account, optionally by name.Read-onlyList Groups
List the contact groups of the ActiveTrail account, optionally by name. Returns groups with ID, name, active and total counters and creation date. Use this to find group IDs. Use activetrail_group_members_list for a group's contacts.
Inputs
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
search_termstring- Group name to search for. Example: Newsletter.
activetrail_mailing_list_getGet one ActiveTrail mailing list.Read-onlyGet Mailing List
Get one ActiveTrail mailing list. Returns the mailing list with ID and name. Use this for a mailing list's details.
Inputs
mailing_list_idintegerrequired- Mailing list ID, from activetrail_mailing_lists_list. Example: 3456.
activetrail_mailing_list_members_listList the contacts in an ActiveTrail mailing list, filtered by status or status-change dates.Read-onlyList Mailing List Members
List the contacts in an ActiveTrail mailing list, filtered by status or status-change dates. Returns contacts with ID, email, mobile, name and statuses. Use this to read a mailing list.
Inputs
mailing_list_idintegerrequired- Mailing list ID, from activetrail_mailing_lists_list. Example: 3456.
customer_statesinteger- Contact status filter as a number: -1 all, -2 active, -3 inactive, 1 unsubscribed by request, 2 bounced, 3 spam complaint, 4 quarantined. Example: -2.one of
-1-2-31234 from_datestring- Start of the status change date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the status change date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_mailing_lists_listList the mailing lists of the ActiveTrail account.Read-onlyList Mailing Lists
List the mailing lists of the ActiveTrail account. Returns mailing lists with ID and name. Use this to find mailing list IDs.
Inputs
This tool takes no inputs.
activetrail_segmentations_listList the saved segmentations of the ActiveTrail account.Read-onlyList Segmentations
List the saved segmentations of the ActiveTrail account. Returns segmentations with ID, name and rules. Use this to find segments used by automations.
Inputs
This tool takes no inputs.
activetrail_sending_profiles_listList the email sending profiles (from addresses) of the ActiveTrail account.Read-onlyList Email Sending Profiles
List the email sending profiles (from addresses) of the ActiveTrail account. Returns profiles with ID, from name and from email. Use this to get the user_profile_id needed to create campaigns and operational emails.
Inputs
This tool takes no inputs.
activetrail_sent_campaigns_listList the email campaigns the ActiveTrail account has sent.Read-onlyList Sent Campaigns
List the email campaigns the ActiveTrail account has sent. Returns campaigns with ID, name, subject and send date. Use this to find campaign IDs for reports.
Inputs
This tool takes no inputs.
activetrail_signup_forms_listList the signup forms of the ActiveTrail account.Read-onlyList Signup Forms
List the signup forms of the ActiveTrail account. Returns forms with ID, name and the groups they add contacts to. Use this to see how contacts join.
Inputs
This tool takes no inputs.
activetrail_sms_campaign_getGet one ActiveTrail SMS campaign.Read-onlyGet SMS Campaign
Get one ActiveTrail SMS campaign. Returns the campaign's name, content, segment and scheduling. Use this for an SMS campaign's details. Use activetrail_sms_campaign_report_get for its results.
Inputs
sms_campaign_idintegerrequired- SMS campaign ID, from activetrail_sms_campaigns_list. Example: 55443.
activetrail_sms_campaign_report_getGet the summary report of one ActiveTrail SMS campaign.Read-onlyGet SMS Campaign Report
Get the summary report of one ActiveTrail SMS campaign. Returns sent, delivered, failed, clicks and unsubscribes. Use this for one SMS campaign's results.
Inputs
sms_campaign_idintegerrequired- SMS campaign ID, from activetrail_sms_campaigns_list. Example: 55443.
activetrail_sms_campaign_reports_listList report summaries of ActiveTrail SMS campaigns.Read-onlyList SMS Campaign Reports
List report summaries of ActiveTrail SMS campaigns. Returns one row per campaign with sent, delivered, failed, clicks and unsubscribes. Use this to compare SMS campaigns.
Inputs
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
search_termstring- Campaign name or part of it. Example: Black Friday.
send_typeinteger- Campaign type: 0 all, 1 regular, 2 operational, 3 automation. Example: 0.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_sms_campaigns_listList the SMS campaigns of the ActiveTrail account, including operational SMS.Read-onlyList SMS Campaigns
List the SMS campaigns of the ActiveTrail account, including operational SMS. Returns campaigns with ID, name, content, status and send date. Use this to find SMS campaign IDs.
Inputs
filter_typeinteger- Campaign type: 0 all, 1 regular, 2 operational, 3 automation. Example: 0.
from_datestring- Start of the last update date range, YYYY-MM-DD. Example: 2026-10-01.
is_include_not_sentboolean- True also lists campaigns not sent yet. Example: true.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
search_termstring- Campaign name or part of it. Example: Black Friday.
to_datestring- End of the last update date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_unsubscribers_listList contacts who unsubscribed, with the source of the unsubscription when known.Read-onlyList Unsubscribers
List contacts who unsubscribed, with the source of the unsubscription when known. Returns unsubscribed contacts with email, date and source. Use this to sync opt-outs to another system.
Inputs
from_datestring- Start of the unsubscription date range, YYYY-MM-DD. Example: 2026-10-01.
limitinteger- Results per page, 1 to 100 (default 20). Example: 50.
pageinteger- Page number, starting at 1. Example: 1.
to_datestring- End of the unsubscription date range, YYYY-MM-DD. Example: 2026-10-31.
activetrail_webhook_getGet one ActiveTrail webhook.Read-onlyGet Webhook
Get one ActiveTrail webhook. Returns the webhook's name, URL, event type, format and parameters. Use this for a webhook's details.
Inputs
webhook_idintegerrequired- Webhook ID, from activetrail_webhooks_list. Example: 321.
activetrail_webhooks_listList the webhooks of the ActiveTrail account.Read-onlyList Webhooks
List the webhooks of the ActiveTrail account. Returns webhooks with ID, name, URL, event type and state. Use this to find webhook IDs.
Inputs
event_typeinteger- Only webhooks for this event type number, such as 8 contact added to group or 10 contact unsubscribed. Example: 10.
is_ignore_parametersboolean- True leaves the webhook parameters out of the response. Example: true.
activetrail_automation_activation_updateActivate (publish) or pause an ActiveTrail automation, now or at a scheduled time.WriteActivate or Pause Automation
Activate (publish) or pause an ActiveTrail automation, now or at a scheduled time. Returns an empty success response. Use this to turn an automation on or off.
- Idempotent
Inputs
automation_idintegerrequired- Automation ID, from activetrail_automations_list. Example: 7788.
is_publishedbooleanrequired- True activates the automation, false pauses it. Example: true.
scheduled_timestring- When to activate, ISO 8601; leave empty for now. Example: 2026-11-20T09:00:00.
activetrail_campaign_contacts_sendCreate and send an ActiveTrail email campaign to specific contacts by email address or contact ID.WriteSend Email Campaign to Contacts
Create and send an ActiveTrail email campaign to specific contacts by email address or contact ID. Returns the created campaign with its ID. Use this for a small list of recipients. Use activetrail_campaign_create for groups.
Inputs
contentstringrequired- Email content as HTML or plain text. Example: <p>Join us on December 1.</p>.
namestringrequired- Internal campaign name. Example: VIP invite.
subjectstringrequired- Email subject line. Example: You're invited.
user_profile_idintegerrequired- Sending profile ID (the from address), from activetrail_sending_profiles_list. Example: 1122.
contacts_emailsarray- Recipient email addresses. Required if contacts_ids is empty. Example: ["jane@example.com"]
contacts_idsarray- Recipient contact IDs. Required if contacts_emails is empty. Example: [123456]
activetrail_campaign_createCreate an ActiveTrail email campaign to groups and schedule it, or send it now with is_sent true.WriteCreate Email Campaign
Create an ActiveTrail email campaign to groups and schedule it, or send it now with is_sent true. Returns the created campaign with its ID. Use this to email groups. Use activetrail_campaign_contacts_send for specific contacts and activetrail_operational_email_send for transactional email.
Inputs
contentstringrequired- Email content as HTML or plain text. Example: <h1>Hello</h1><p>Here is our November update.</p>.
group_idsarrayrequired- IDs of the groups to send to. Example: [45678]
is_sentbooleanrequired- True sends the campaign now; false schedules it for scheduled_date_utc. Example: false.
namestringrequired- Internal campaign name. Example: November newsletter.
scheduled_date_utcstringrequired- When to send, in UTC (ISO 8601). Use the current time with is_sent true. Example: 2026-11-20T09:00:00Z.
subjectstringrequired- Email subject line. Example: What's new in November.
user_profile_idintegerrequired- Sending profile ID (the from address), from activetrail_sending_profiles_list. Example: 1122.
mailing_list_idinteger- Mailing list ID; required if the account uses mailing lists. Example: 3456.
preheaderstring- Preheader text shown after the subject. Example: Our latest product updates.
send_teststring- Comma-separated email addresses to send a test copy to. Example: me@example.com.
activetrail_contact_createCreate an ActiveTrail contact; it is not added to any group, so it cannot be mailed until you add it to one.WriteCreate Contact
Create an ActiveTrail contact; it is not added to any group, so it cannot be mailed until you add it to one. Returns the created contact with its ID. Use activetrail_group_member_add instead to create a contact and put it in a group in one call.
Inputs
birthdaystring- Birthday, YYYY-MM-DD. Example: 1990-05-17.
citystring- City. Example: Tel Aviv.
emailstring- Contact's email address. Required if sms is empty. Example: jane@example.com.
ext1string- Custom field ext1; activetrail_contact_fields_list shows what each ext field holds. Example: Gold.
first_namestring- First name. Example: Jane.
last_namestring- Last name. Example: Doe.
phone1string- Phone number. Example: +97231234567.
smsstring- Contact's mobile number. Required if email is empty. Example: +972501234567.
sms_statusinteger- SMS subscription status as a number: 0 none, 1 subscribed, 2 unsubscribed, 3 pending. Example: 1.one of
0123 statusinteger- Email subscription status as a number: 0 none, 1 subscribed, 2 unsubscribed, 3 pending. Example: 1.one of
0123 streetstring- Street address. Example: 1 Rothschild Blvd.
subscribe_ipstring- IP address the contact subscribed from. Example: 203.0.113.10.
zip_codestring- Postal code. Example: 6688101.
activetrail_contact_updateUpdate an ActiveTrail contact's details or subscription status.WriteUpdate Contact
Update an ActiveTrail contact's details or subscription status. Returns an empty success response. Use this to change contact fields. Use activetrail_contact_get to read them.
- Idempotent
Inputs
contact_idintegerrequired- Contact ID, from activetrail_contacts_list. Example: 123456.
birthdaystring- Birthday, YYYY-MM-DD. Example: 1990-05-17.
citystring- City. Example: Tel Aviv.
emailstring- Contact's email address. Required if sms is empty. Example: jane@example.com.
ext1string- Custom field ext1; activetrail_contact_fields_list shows what each ext field holds. Example: Gold.
first_namestring- First name. Example: Jane.
last_namestring- Last name. Example: Doe.
phone1string- Phone number. Example: +97231234567.
smsstring- Contact's mobile number. Required if email is empty. Example: +972501234567.
sms_statusinteger- SMS subscription status as a number: 0 none, 1 subscribed, 2 unsubscribed, 3 pending. Example: 1.one of
0123 statusinteger- Email subscription status as a number: 0 none, 1 subscribed, 2 unsubscribed, 3 pending. Example: 1.one of
0123 streetstring- Street address. Example: 1 Rothschild Blvd.
subscribe_ipstring- IP address the contact subscribed from. Example: 203.0.113.10.
zip_codestring- Postal code. Example: 6688101.
activetrail_contacts_importImport up to 1,000 contacts into an ActiveTrail group, creating or updating them.WriteImport Contacts
Import up to 1,000 contacts into an ActiveTrail group, creating or updating them. Returns the import result with counts of created, updated and failed contacts. Use this for bulk adds. Use activetrail_group_member_add for one contact.
Inputs
contactsarrayrequired- Contacts to import, each an object with Email or SMS and optional FirstName, LastName, City, Phone1, Birthday and Ext1..Ext25. Example: [{"Email": "jane@example.com", "FirstName": "Jane"}, {"SMS": "+972501234567"}]
groupintegerrequired- ID of the group to import into. Example: 45678.
mailing_listinteger- ID of a mailing list to add the contacts to; leave empty if the account has no mailing lists. Example: 3456.
activetrail_group_createCreate an ActiveTrail contact group.WriteCreate Group
Create an ActiveTrail contact group. Returns the created group with its ID. Use this to add a group. Use activetrail_group_member_add to fill it.
Inputs
namestringrequired- Group name. Example: Newsletter subscribers.
activetrail_group_member_addAdd a contact to an ActiveTrail group, creating the contact if needed, and set its status; optionally send it a campaign.WriteAdd Group Member
Add a contact to an ActiveTrail group, creating the contact if needed, and set its status; optionally send it a campaign. Returns the contact as added. Use this to subscribe someone to a group. Contacts that are inactive cannot be re-added as subscribed.
Inputs
group_idintegerrequired- Group ID, from activetrail_groups_list or the group's URL in ActiveTrail (Contacts > Groups). Example: 45678.
birthdaystring- Birthday, YYYY-MM-DD. Example: 1990-05-17.
campaign_idinteger- ID of a campaign to send to the added contact. Example: 987654.
citystring- City. Example: Tel Aviv.
emailstring- Contact's email address. Required if sms is empty. Example: jane@example.com.
ext1string- Custom field ext1; activetrail_contact_fields_list shows what each ext field holds. Example: Gold.
first_namestring- First name. Example: Jane.
last_namestring- Last name. Example: Doe.
phone1string- Phone number. Example: +97231234567.
smsstring- Contact's mobile number. Required if email is empty. Example: +972501234567.
sms_statusinteger- SMS subscription status as a number: 0 none, 1 subscribed, 2 unsubscribed, 3 pending. Example: 1.one of
0123 statusinteger- Email subscription status as a number: 0 none, 1 subscribed, 2 unsubscribed, 3 pending. Example: 1.one of
0123 streetstring- Street address. Example: 1 Rothschild Blvd.
subscribe_ipstring- IP address the contact subscribed from. Example: 203.0.113.10.
zip_codestring- Postal code. Example: 6688101.
activetrail_group_updateRename an ActiveTrail group.WriteRename Group
Rename an ActiveTrail group. Returns an empty success response. Use this to change a group's name.
- Idempotent
Inputs
group_idintegerrequired- Group ID, from activetrail_groups_list or the group's URL in ActiveTrail (Contacts > Groups). Example: 45678.
namestringrequired- New group name. Example: Newsletter 2026.
activetrail_mailing_list_createCreate an ActiveTrail mailing list.WriteCreate Mailing List
Create an ActiveTrail mailing list. Returns the created mailing list with its ID. Use this to add a mailing list.
Inputs
namestringrequired- Mailing list name. Example: Customers.
activetrail_mailing_list_member_addAdd a contact to an ActiveTrail mailing list and to one or more groups.WriteAdd Mailing List Member
Add a contact to an ActiveTrail mailing list and to one or more groups. Returns the contact as added. Use this for accounts that use mailing lists.
Inputs
group_idsarrayrequired- IDs of the groups to add the contact to. Example: [45678]
mailing_list_idintegerrequired- Mailing list ID, from activetrail_mailing_lists_list. Example: 3456.
emailstring- Contact's email address. Required if sms is empty. Example: jane@example.com.
first_namestring- First name. Example: Jane.
last_namestring- Last name. Example: Doe.
smsstring- Contact's mobile number. Required if email is empty. Example: +972501234567.
sms_statusinteger- SMS subscription status as a number: 0 none, 1 subscribed, 2 unsubscribed, 3 pending. Example: 1.one of
0123 statusinteger- Email subscription status as a number: 0 none, 1 subscribed, 2 unsubscribed, 3 pending. Example: 1.one of
0123
activetrail_operational_email_sendSend a transactional (operational) email to up to 500 addresses, with per-recipient personalization; recipients are created as contacts.WriteSend Operational Email
Send a transactional (operational) email to up to 500 addresses, with per-recipient personalization; recipients are created as contacts. Returns the sent message details. Use this for receipts and notifications. Use activetrail_campaign_create for marketing email.
Inputs
classificationstringrequired- Category for grouping operational messages in reports, such as Order shipped. Example: Order shipped.
contentstringrequired- Email content as HTML; personalization keys from email_package pairs can be used. Example: <p>Hi, your order has shipped.</p>.
email_packagearrayrequired- Recipients, each an object with email and optional pairs of key/value personalization. Example: [{"email": "jane@example.com", "pairs": [{"key": "order", "value": "1001"}]}]
subjectstringrequired- Email subject. Example: Your order #1001 has shipped.
user_profile_idintegerrequired- Sending profile ID (the from address), from activetrail_sending_profiles_list. Example: 1122.
namestring- Internal name of the message. Example: Shipping confirmation.
activetrail_operational_sms_sendSend a transactional (operational) SMS to specific mobile numbers, now or scheduled.WriteSend Operational SMS
Send a transactional (operational) SMS to specific mobile numbers, now or scheduled. Returns the created operational SMS. Use this for one-to-one texts such as codes and alerts. Use activetrail_sms_campaign_create for groups.
Inputs
contentstringrequired- SMS text. Example: Your order arrives today between 10:00 and 12:00.
mobilesarrayrequired- Recipients, each an object with phone_number. Example: [{"phone_number": "+972501234567"}]
namestringrequired- Internal name of the message. Example: Delivery alert.
send_nowbooleanrequired- True sends now; false sends at scheduled_date_utc. Example: true.
from_namestring- Sender name. Required if sms_sending_profile_id is empty. Example: AcmeShop.
scheduled_date_utcstring- When to send, in UTC (ISO 8601), if not sending now. Example: 2026-11-20T09:00:00Z.
sms_sending_profile_idinteger- SMS sending profile ID. Required if from_name is empty. Example: 77.
activetrail_sms_campaign_createCreate an ActiveTrail SMS campaign to groups and send it now or schedule it.WriteCreate SMS Campaign
Create an ActiveTrail SMS campaign to groups and send it now or schedule it. Returns the created SMS campaign with its ID. Use this to text groups. Use activetrail_operational_sms_send for specific numbers.
Inputs
contentstringrequired- SMS text. Example: Black Friday: 30% off everything today only!.
group_idsarrayrequired- IDs of the groups to send to. Example: [45678]
is_sentbooleanrequired- True sends the campaign now; false sends at scheduled_date. Example: true.
namestringrequired- Internal campaign name. Example: Black Friday SMS.
unsubscribe_textstringrequired- Unsubscribe text, required even when no unsubscribe link is added. Example: Reply STOP to unsubscribe.
can_unsubscribeboolean- True adds an unsubscribe link. Example: true.
from_namestring- Sender name, up to 11 characters. Required if sms_sending_profile_id is empty. Example: AcmeShop.
is_link_trackingboolean- True tracks links in the SMS. Example: true.
scheduled_datestring- When to send, ISO 8601, if not sending now. Example: 2026-11-27T08:00:00.
sms_sending_profile_idinteger- SMS sending profile ID. Required if from_name is empty. Example: 77.
activetrail_webhook_createCreate an ActiveTrail webhook that calls your URL when an event happens, such as a contact unsubscribing.WriteCreate Webhook
Create an ActiveTrail webhook that calls your URL when an event happens, such as a contact unsubscribing. Returns the created webhook with its ID. Use this to get event notifications.
Inputs
event_typeintegerrequired- Event number: 1 contact change, 6 manual contact change, 7 automation step, 8 added to group, 9 removed from group, 10 unsubscribed, 11 contact updated, 12 added via landing page, 13 added via signup form, 14 order created, 15 order updated, 16 lead created, 17 lead updated, 18 opportunity created, 19 opportunity updated. Example: 10.
namestringrequired- Webhook name. Example: Unsubscribe sync.
urlstringrequired- URL ActiveTrail calls. Example: https://example.com/hooks/activetrail.
formatinteger- Payload format: 1 JSON, 2 form URL-encoded. Example: 1.one of
12 is_activeboolean- True turns the webhook on. Example: true.
activetrail_campaign_deleteDelete an ActiveTrail email campaign.DestructiveDelete Email Campaign
Delete an ActiveTrail email campaign. Returns an empty success response. Use this to remove a draft or scheduled campaign.
- Idempotent
Inputs
campaign_idintegerrequired- Email campaign ID, from activetrail_sent_campaigns_list or activetrail_campaign_reports_list. Example: 987654.
activetrail_contact_deleteDelete an ActiveTrail contact.DestructiveDelete Contact
Delete an ActiveTrail contact. Returns an empty success response. Use this to remove a contact for good. Use activetrail_contact_update with status 2 to unsubscribe instead.
- Idempotent
Inputs
contact_idintegerrequired- Contact ID, from activetrail_contacts_list. Example: 123456.
activetrail_group_deleteDelete an ActiveTrail group; its contacts stay in the account.DestructiveDelete Group
Delete an ActiveTrail group; its contacts stay in the account. Returns an empty success response. Use this to remove a group.
- Idempotent
Inputs
group_idintegerrequired- Group ID, from activetrail_groups_list or the group's URL in ActiveTrail (Contacts > Groups). Example: 45678.
activetrail_group_member_removeRemove a contact from an ActiveTrail group; the contact stays in the account.DestructiveRemove Group Member
Remove a contact from an ActiveTrail group; the contact stays in the account. Returns an empty success response. Use this to take someone out of a group.
- Idempotent
Inputs
contact_idintegerrequired- ID of the contact to remove, from activetrail_group_members_list. Example: 123456.
group_idintegerrequired- Group ID, from activetrail_groups_list or the group's URL in ActiveTrail (Contacts > Groups). Example: 45678.
activetrail_mailing_list_deleteDelete an ActiveTrail mailing list.DestructiveDelete Mailing List
Delete an ActiveTrail mailing list. Returns an empty success response. Use this to remove a mailing list.
- Idempotent
Inputs
mailing_list_idintegerrequired- Mailing list ID, from activetrail_mailing_lists_list. Example: 3456.
activetrail_mailing_list_member_removeRemove a contact from an ActiveTrail mailing list.DestructiveRemove Mailing List Member
Remove a contact from an ActiveTrail mailing list. Returns an empty success response. Use this to take someone off a mailing list.
- Idempotent
Inputs
contact_idintegerrequired- ID of the contact to remove. Example: 123456.
mailing_list_idintegerrequired- Mailing list ID, from activetrail_mailing_lists_list. Example: 3456.
activetrail_webhook_deleteDelete an ActiveTrail webhook.DestructiveDelete Webhook
Delete an ActiveTrail webhook. Returns an empty success response. Use this to stop event notifications.
- Idempotent
Inputs
webhook_idintegerrequired- Webhook ID, from activetrail_webhooks_list. Example: 321.
No tools match.