Account

Account settings

Method

Endpoint

Description

GET

Get email and SMS credit balance.

GET

Get the account Sending Profiles

GET

Has the account waiting merges

GET

Get the account integration Data

Set the account integration Data

GET

Return a list of categories

GET

Get user Approved notifications status

Create notifications status

PUT

Update notifications status

POST HTML encoded value of string

Top

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

Get automation details of users logged in a journey

GET

Get automation details of users who completed an automation journey

GET

Get email reports of email campaigns in your automation journeys

GET

Get SMS reports of SMS in your automation journeys

GET

Returns the overview report for the requested automation

GET

Returns the Campaign Summary report for the requested automation

GET

Returns the SMSCampaign Summary report for the requested automation

GET

Returns List contacts will get to the end of the automation

Top

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

GET

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.

Top

Automations

All the automation options are available to you here; create, edit, design, create triggers and send automated campaigns

Method

Endpoint

Description

GET

Get the automation info by its id

GET

Get list of automations limited to a number of automations (you will get the last 20 automations)

Create a new automation

PUT

Update the given automation

PUT

Update the date event trigger that activates the given automation

Delete the given automation/s

GET

Get Date event trigger that activates the given automation

GET

Get the event trigger that activates the given automation

PUT

Update the event trigger that activates the given automation

GET

Return the properties of the given automation

PUT

Update the properties of the given automation id

GET

Get the JSON that represents the design of the automation flow in the UI

PUT

Update the JSON that represents the design of the automation flow in the UI

GET

Get the JSON that represents the design of the automation flow in the UI including the data of the given automation

PUT

Update the JSON that represents the design of the automation flow in the UI including the data of the given automation

GET

Get the JSON that represents the design of the automation flow in the UI including the data of the given automation

GET

Get a certain automation step info in the automation flow

Add a new automation step in the automation flow

PUT

Update an automation step in the automation flow

GET

Get all the steps in the automation that are for email campaigns

GET

Get a certain email automation step info in the automation flow

Add an email campaign step in the automation

PUT

Update an email campaign step in the automation

GET

Get all the steps in the automation that are for SMS campaign

GET

Get a certain SMS automation step info in the automation flow

Add an SMS campaign step in the automation

PUT

Update an SMS campaign step in the automation

GET

Get a certain Contact Update step info in the automation flow

Add a Contact Update step in the automation

PUT

Update a Contact Update step in the automation

GET

Get a certain AB Split step info in the automation flow

Add an AB Split step in the automation

PUT

Update an AB Split step in the automation

GET

Get a notify email step info in the automation flow

Add a notify email step in the automation

PUT

Update a notify email step in the automation

GET

Return the activation of the given automation

PUT

Save the activation of the given automation id

PUT

Update the template of the given automation id

GET

Send a test request for the given Event

Send test details of automation

Top

Automation template categories

Access to all the categories that you created for your automation templates

Method

Endpoint

Description

GET

Get automation template categories by fetch type (templates of users or system)

Creates and returns a new automation template category.

PUT

Update the given automation template category

Delete the given automation template category

Top

Automation triggers

Get all the options for start triggers

Method

Endpoint

Description

GET

Get all the start trigger options for automations

Top

Campaigns

Create, edit, design, delete, schedule and send email campaigns

Method

Endpoint

Description

GET

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)

GET

Get campaign by id

Create and return a new campaign

PUT

Update campaign

GET

Get campaign details by id

PUT

Update campaign details by id

GET

Get campaign template

PUT

Update campaign template

GET

Get campaign body by id

PUT

Update campaign body by id

GET

Get campaign sending settings (groups and sending restrictions)

PUT

Update campaign sending settings (groups and sending restrictions)

GET

Get campaign schdule by id

PUT

Update campaign schdule by id

Delete campaign by id

GET

Return a list of sent campaigns

Create and Send a new campaign To specific contacts

Top

Campaign Reports

View your campaign reports, get a comparison report, get open rates, CTR rates, unsubcscribe rates and activity report

Method

Endpoint

Description

GET

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.

Top

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

GET

Get all your Templates that are saved in 'My Templates'

GET

Get a specific Template by the template id from the list of 'My Templates'

Create and return a new template.

PUT

Update the given template

Delete the given template.

GET

Get the template content (html) by id

PUT

Create and return a new template content.

Create a campaign from the templates.

GET

Get a specific templates categories

Create and return a new template category.

PUT

Update the given template category

Delete the given template category.

Top

Contacts

Manage your contacts and subscriptions in this section, get all the contacts' details, create and remove contacts.

Method

Endpoint

Description

GET

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

Get contact by the contact id

Create and return a new contact

Import contacts

PUT

Update the given Contact

Delete the given Contact

GET

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)

GET

Get a merge conflict by the merge contact id

PUT

Resolve the given conflict

Delete the given conflict

GET

Gets all contacts that are unsubscribed from getting sms messages

GET

Gets customer statistics for specific campaign

GET

Gets customer statistics for specific operation message

Top

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

Get the Webhook of a given id

Creates a new Webhook

PUT

Update a Webhook by a given id

Delete a Webhook by a given id

GET

Get parameters details by a given id

GET

Get the Webhook Parameters for a given webhook id (used mostly for authentication)

Create a new Webhook Parameter

PUT

Update a given Webhook Parameter

Delete a given Webhook Parameter

Send a test request for a given Webhook

Send a test request with a given url and parameters

Top

Groups

Manage groups on your account. View/ Create/ Update / delete groups, add or remove contacts

Method

Endpoint

Description

GET

Get the full list of your groups, limited to a number of groups (the default is 50 groups each time).

GET

Get group by id

Create and return a new Group.

PUT

Update a given group

Delete a given group

GET

Get a group member information by id

Update a member or create a new member in a group and send a campaign by campaign id if provided

Remove member from a group

Top

Mailing List

Manage mailing list on your account. View/ Create/ Update / delete mailing list, add or remove contacts

Method

Endpoint

Description

GET

Get the full list of your MailingLists.

GET

Get MailingList by id

Create and return a new Mailing List.

Delete a given MailingList

GET

Get all the information of your Mailinglist members by page, limited to 50 contacts each time.

GET

Get a MailingList member information by id

Update a member or create a new member in a Mailinglist

Remove member from mailing list

Top

Operational Message

Method

Endpoint

Description

DEPRECATE. Create and send a new message to Email addresses

Create and send a new message to Email addresses

Create and send a new message to Contacts

Top

Segmentations

All the segmentation options are available to you here such as: create and edit

Method

Endpoint

Description

GET

Get the segmentation info by its id

GET

Get list of all user's segmentations

Create a new segmentation

PUT

Update the given segmentation

GET

Get dictionary of rules field types

GET

Get dictionary of rules field types

GET

Get dictionary of rules operations

GET

Get a full mapping of operations and field types associated to the type of rule.

GET

Get the segmentation's description in the specified language.

Top

SignupForms

View the details of your sign up forms

Method

Endpoint

Description

GET

Get sign-up form by id

GET

Get all your sign-up forms

GET

Get landing Page by id

GET

Get all your landing Pages

Top

Smart Code Site

Method

Endpoint

Description

GET

Get a list of all user's Smart Code sites

GET

Get Smart Code Site info

Create a new Smart Code site

Verify if the Smart Code is implemented correctly on the given site

PUT

Updates the exisiting Samrt Code site by site id

Delete a given smart Code site

Create a new conversion for a given campaign

Top

SMS Campaign

Create, edit, design, delete, schedule and send sms campaigns

Method

Endpoint

Description

GET

Get SMS campaigns. You can get sms campaigns filtered (you will get the last 20 campaigns in the last 6 months by default)

GET

Get SMS campaign by id

Create and return a new SMS campaign

GET

Calculating the estimated number of messages for given campaign by id

GET

Get SMS message. You can get sms messages filtered (you will get the last 20 campaigns in the last 6 months by default)

Create and return a new SMS message

Top

SMS Campaign Report

sms campaigns reports

SMS Campaign Request

Create and send SMS campaigns from query string.