Account
Account settings
Method
Endpoint
Description
Automation Reports
Get reports of all your automation campaigns, divided into users who are currently logged in an automation journey and to users who completed a journey
Method
Endpoint
Description
Get automation details of users who completed an automation journey
Get email reports of email campaigns in your automation journeys
Get SMS reports of SMS in your automation journeys
Get WhatsApp reports of WhatsApp in your automation journeys
Get PushNotification reports of PushNotification in your automation journeys
Get InAppMessage reports of InAppMessage in your automation journeys
Returns the overview report for the requested automation
Returns the Campaign Summary report for the requested automation
Returns the SMSCampaign Summary report for the requested automation
Returns List Contacts Started automation
Returns List contacts will get to the end of the automation
Automation templates
The automation templates are comprised of ‘System templates and ‘My Templates’. The system templates are predesigned and are based on several triggers, and each one of them starts an automation journey. You can view the different automation templates here, pull the templates you want and save them to ‘My templates’. In the app you can edit ‘My Templates’ according to your preference, using the drag and drop editor or add steps. In the API you can edit them through adding steps and configuring the workflow.
Method
Endpoint
Description
The automation templates are comprised of ‘System templates and ‘My Templates’. The system templates are predesigned and are based on several triggers that each one of them starts an automation journey. You can view the different automation templates, get the templates you want and save them to ‘My templates’. In the app you can edit ‘My Templates’ according to your preference, using the drag and drop editor, and you can also add steps. In the API you can edit the templates by adding steps and configuring the workflow.
Automations
All the automation options are available to you here; create, edit, design, create triggers and send automated campaigns
Method
Endpoint
Description
Get list of automations limited to a number of automations (you will get the last 20 automations)
Update the date event trigger that activates the given automation
Get Date event trigger that activates the given automation
Get the JSON that represents the design of the automation flow in the UI
Update the JSON that represents the design of the automation flow in the UI
Get the JSON that represents the design of the automation flow in the UI including the data of the given automation
Update the JSON that represents the design of the automation flow in the UI including the data of the given automation
Get the JSON that represents the design of the automation flow in the UI including the data of the given automation
Get all the steps in the automation that are for email campaigns
Get a certain email automation step info in the automation flow
Update an email campaign step in the automation
Get all the steps in the automation that are for SMS campaign
Get a certain SMS automation step info in the automation flow
Get a certain WhatsApp automation step info in the automation flow
Update an WhatsApp campaign step in the automation
Add an Push Notification campaign step in the automation
Update an Push Notification step in the automation
Get a Push Notification automation step info in the automation flow
Get a certain Contact Update step info in the automation flow
Get a certain AB Split step info in the automation flow
Automation template categories
Access to all the categories that you created for your automation templates
Method
Endpoint
Description
Get automation template categories by fetch type (templates of users or system)
Automation triggers
Get all the options for start triggers
Method
Endpoint
Description
Campaigns
Create, edit, design, delete, schedule and send email campaigns
Method
Endpoint
Description
Get campaigns. You can get campaigns filtered by date (from/to date, the defualt is three months back) and limited to a number of campaigns (you will get the last 20 campaigns in the last 6 months by default)
Campaign Reports
View your campaign reports, get a comparison report, get open rates, CTR rates, unsubcscribe rates and activity report
Method
Endpoint
Description
Get all the reports of your campaigns that include: send date, opened emails, number of clicks, CTO, bounces, unsubscribers, complaints and unopened and sent emails.
Get an overview report for a campaign
Get a click report by campaign id
Get clickdetails by link id
Get a specific user unsubscribed by campaign id
Get a specific user activity by Campaign id
Get a Campaign opens
Get a Campaign Sent
Get a Campaign Unopened
Get a Campaign Complaints
Get a Campaign Bounces
Campaign Templates
Access to templates that are saved in your account under 'My Templates'. You can get all the templates, get specific template by id or create a new template and save it to 'My Templates'. You also have functions to get thet HTML of the saved template seperately from the template itself.
Method
Endpoint
Description
Contacts
Manage your contacts and subscriptions in this section, get all the contacts' details, create and remove contacts.
Method
Endpoint
Description
Get the contact list. You can get the list filtered by customer status (active, unsubscribed, bounced. etc.,) by the registration date (from/to date, the defualt is three months back) and limited to a number of contacts (the default is 50 contacts each time)
Get the list of contact conflicts that are waiting for merge. You can get the list filtered by conflict status (active, inactive, deleted, etc.) by the conflict's occurrence date (from/to date, the defualt is three months back) and limited to a number of conflicts (the default is 50 conflicts each time)
Gets all contacts that are unsubscribed from getting sms messages
Gets customer statistics for specific campaign
Gets customer statistics for specific operation message
Gets customer statistics for specific operation message
Web hooks
Define the parameters and the URLs of the following webhooks events: manually updating the contact info in the ActiveTrail app and updating the contact info programmatically via forms/import etc.
Method
Endpoint
Description
Get all the Webhooks info in your account
Get the Webhook Parameters for a given webhook id (used mostly for authentication)
Groups
Manage groups on your account. View/ Create/ Update / delete groups, add or remove contacts
Method
Endpoint
Description
Get the full list of your groups, limited to a number of groups (the default is 50 groups each time).
Get all the information of your group members by page, limited to 50 contacts each time.
Update a member or create a new member in a group and send a campaign by campaign id if provided
Mailing List
Manage mailing list on your account. View/ Create/ Update / delete mailing list, add or remove contacts
Method
Endpoint
Description
Get all the information of your Mailinglist members by page, limited to 50 contacts each time.
Operational Message
Method
Endpoint
Description
Push Campaign
Create, edit, design, delete, schedule and send push campaigns
Method
Endpoint
Description
Get Push campaigns. You can get Push campaigns filtered (you will get the last 20 campaigns in the last 6 months by default)
Calculating the estimated number of messages for given campaign by id
Calculating the estimated number of messages for given campaign by id
Push Campaign Report
Push campaigns reports
Method
Endpoint
Description
Get Push campaignsreports . You can get Push campaigns reports filtered (you will get the last 20 campaigns in the last 6 months by default)
Getting the Summary report info of an Push campaign
Get clickdetails by link id
Segmentations
All the segmentation options are available to you here such as: create and edit
Method
Endpoint
Description
Get a full mapping of operations and field types associated to the type of rule.
Get the segmentation's description in the specified language.
SignupForms
View the details of your sign up forms
Method
Endpoint
Description
Smart Code Site
Method
Endpoint
Description
SMS Campaign
Create, edit, design, delete, schedule and send sms campaigns
Method
Endpoint
Description
Get SMS campaigns. You can get sms campaigns filtered (you will get the last 20 campaigns in the last 6 months by default)
Calculating the estimated number of messages for given campaign by id
Calculating the estimated number of messages for given campaign by id
Get SMS message. You can get sms messages filtered (you will get the last 20 campaigns in the last 6 months by default)
SMS Campaign Report
sms campaigns reports
Method
Endpoint
Description
Get SMS campaignsreports . You can get sms campaigns reports filtered (you will get the last 20 campaigns in the last 6 months by default)
Getting the Summary report info of an sms campaign
Get clickdetails by link id
SMS Campaign Request
Create and send SMS campaigns from query string.
Method
Endpoint
Description
Send sms campaign request from query string.
Send sms campaign request from query string.
User Social
Get all the options for start triggers
Method
Endpoint
Description
Two Way Sms
Create, edit, design, delete, schedule and send sms campaigns
Method
Endpoint
Description
Get 2 way sms replies
WhatsApp Campaign
Create, edit, design, delete, schedule and send whatsapp campaigns
Method
Endpoint
Description
Get WhatsApp campaigns. You can get WhatsApp campaigns filtered (you will get the last 20 campaigns in the last 6 months by default)
Calculating the estimated number of messages for given campaign by id
Calculating the estimated number of messages for given campaign by id
WhatsApp Campaign Report
whatsapp campaigns reports
Method
Endpoint
Description
Get WhastApp campaignsreports . You can get whatsapp campaigns reports filtered (you will get the last 20 campaigns in the last 6 months by default)
Getting the Summary report info of an whatsapp campaign
Get clickdetails by link id