Read automations and their steps (email, SMS, WhatsApp, push, contact update and more), update automation details and email and SMS steps, activate or deactivate automations, send tests, delete automations, and list the available start triggers.
All endpoints use the base URL https://webapi.mymarketing.co.il and an API key in the Authorization header. New to the API? Start with Get started with the ActiveTrail API.
Endpoints
| Method | Endpoint | What it does |
|---|---|---|
GET | /api/ | Get an automation's information by its ID |
GET | /api/ | Get account's automations |
DELETE | /api/ | Delete the given automation |
GET | /api/ | Get trigger's information of a specific "contact celebrates a date" automation |
GET | /api/ | Get a specific automation's trigger information |
GET | /api/ | Get the details (excluding the steps) of a specific automation |
PUT | /api/ | Update the setup of the given automation |
GET | /api/ | Get the JSON that represents the design of the automation flow in the UI |
GET | /api/ | Get the automation flow design, including its steps |
GET | /api/ | Get the automation's steps flow |
GET | /api/ | Getting report details for given step |
GET | /api/ | Get a certain automation step information in the given automation |
GET | /api/ | Get all the 'send email' steps in a given automation |
GET | /api/ | Get the information of a specific email step in the given automation |
PUT | /api/ | Update an email campaign step in a given automation |
GET | /api/ | Get all the 'send SMS' steps in a given automation |
GET | /api/ | Get the information of a specific SMS step in the given automation |
PUT | /api/ | Update an SMS campaign step in the automation |
GET | /api/ | Get the information of a specific Whatsapp step in the given automation |
GET | /api/ | Get the information of a specific push notification step in the given automation |
GET | /api/ | Get the information of a specific 'contact update' step in the given automation |
GET | /api/ | Get the information of a specific Social step in the given automation |
GET | /api/ | Get the information of a specific A/B split step in the given automation |
GET | /api/ | Get the information of a specific 'notify someone' step in the given automation |
GET | /api/ | Get the activation status of the given automation |
PUT | /api/ | Activate/de-activate a given automation |
GET | /api/ | Get all the types of actions that can be updated for a contact in an automation |
POST | /api/ | Send test campaigns from the given automation |
GET | /api/ | Get all the start trigger options for automations |
Endpoint details
Get an automation's information by its ID
GET https://webapi.mymarketing.co.il/api/automations/{id}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get account's automations
GET https://webapi.mymarketing.co.il/api/automations
| Parameter | In | Type | Description |
|---|---|---|---|
state_type | query | TypesAutomationStateTypes | Get status type from list |
page | query | integer | Get a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647) |
limit | query | integer | Limit the number of items you get in the results. (Removing the "limit" will, by default, display only 20 records) (Range: inclusive between 1 and 100) |
Full reference, request and response samples
Delete the given automation
DELETE https://webapi.mymarketing.co.il/api/automations/{ids}
Delete the given automation. You can delete a few in a bulk if the IDs are separated with a comma (',')
| Parameter | In | Type | Description |
|---|---|---|---|
ids | path | string | string representing automations ids separated by comma (','). Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get trigger's information of a specific "contact celebrates a date" automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/DateEventTriggerData
Get trigger's information of a specific "contact celebrates a date" automation. Providing an automation id that has a different trigger will result in an error.
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get a specific automation's trigger information
GET https://webapi.mymarketing.co.il/api/automations/{id}/triggerInfo
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the details (excluding the steps) of a specific automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/details
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Update the setup of the given automation
PUT https://webapi.mymarketing.co.il/api/automations/{id}/details
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
name | body | string | Name of automation |
allow_trigger_multiple_times | body | boolean | If a contact can go through the automation multipule times |
prevent_simultaneous_automation_runs | body | boolean | If a contact can start the same automation multipule times simultaneously |
report_interval_type | body | TypesAutomationReportIntervalTypes | Interval type of report sending (0 / 12 / 24 /36 ) |
report_send_to | body | string | Email address that will receive the reports |
is_send_report | body | boolean | If to send report |
date_updated_utc | body | date | The UTC date when the automation was last updated |
date_created_utc | body | date | The UTC date when the automation was created |
extended_details | body | ApiAutomationExtendedDetailsInfo | Object that contains the extended automation details (reruntrigger, etc.) See AutomationExtendedDetailsInfo for more information |
The request body is a JSON object (ApiAutomationDetailsInfo).
Full reference, request and response samples
Get the JSON that represents the design of the automation flow in the UI
GET https://webapi.mymarketing.co.il/api/automations/{id}/chartData
Get the JSON that represents the design of the automation flow in the UI(excluding automation's steps)
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the automation flow design, including its steps
GET https://webapi.mymarketing.co.il/api/automations/{id}/design
Get the JSON of the automation flow as the editor shows it, with the data of its steps (step IDs included).
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the automation's steps flow
GET https://webapi.mymarketing.co.il/api/automations/{id}/FlowTimesStarted
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Getting report details for given step
GET https://webapi.mymarketing.co.il/api/automations/{id}/AutomationStepReportDetails/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get the automation flow design, including its steps" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get a certain automation step information in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/Steps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get the automation flow design, including its steps" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get all the 'send email' steps in a given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/EmailCampaignSteps
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the information of a specific email step in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/EmailCampaignSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get all the 'send email' steps in a given automation" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Update an email campaign step in a given automation
PUT https://webapi.mymarketing.co.il/api/automations/{id}/EmailCampaignSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get all the 'send email' steps in a given automation" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
email_name | body | string | Email name Required. |
user_profile_id | body | integer | Sending profile id from list Required. |
email_subject | body | string | Campaign subject Required. |
preheader | body | string | Preheader |
attachment_file_name | body | string | Attachment file name |
attachment_file_url | body | string | Attachement url |
is_active | body | boolean | If the step is active Required. |
working_days | body | Collection of AutomationExtendedDetailsWorkingDays | |
holidays | body | AutomationExtendedDetailsHolidays | |
analytics_campaign_name | body | string | analytics campaign name |
add_analytics_tracking_to_links | body | boolean | add_analytics_tracking_to_links |
add_statistics | body | boolean | Allow statistics tracking |
The request body is a JSON object (ApiAutomationEmailStepUpdateInfo).
Full reference, request and response samples
Get all the 'send SMS' steps in a given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/SMSCampaignSteps
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the information of a specific SMS step in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/SMSCampaignSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get all the 'send SMS' steps in a given automation" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Update an SMS campaign step in the automation
PUT https://webapi.mymarketing.co.il/api/automations/{id}/SMSCampaignSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get all the 'send SMS' steps in a given automation" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
campaign_name | body | string | Campaign name Required. |
user_sms_profile_id | body | integer | User Sms Profile Id Required. |
from_name | body | string | From name Required. |
content | body | string | Message content Required. |
is_link_tracking | body | boolean | If the links are tracked |
unsubscribe_text | body | string | Unsubscribe text to add to link |
is_active | body | boolean | If the step is active Required. |
working_days | body | Collection of AutomationExtendedDetailsWorkingDays | |
holidays | body | AutomationExtendedDetailsHolidays |
The request body is a JSON object (ApiAutomationSmsStepUpdateInfo).
Full reference, request and response samples
Get the information of a specific Whatsapp step in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/WhatsAppCampaignSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get the automation flow design, including its steps" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the information of a specific push notification step in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/PushNotificationSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get the automation flow design, including its steps" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the information of a specific 'contact update' step in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/ContactUpdateSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get the automation flow design, including its steps" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the information of a specific Social step in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/SocialSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get the automation flow design, including its steps" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> click on the desired step -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Get the information of a specific A/B split step in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/ABSplitSteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get the automation flow design, including its steps" Required. |
Full reference, request and response samples
Get the information of a specific 'notify someone' step in the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/NotifySteps/{stepId}
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
stepId | path | integer | Step id. Can be found using the endpoint "Get the automation flow design, including its steps" Required. |
Full reference, request and response samples
Get the activation status of the given automation
GET https://webapi.mymarketing.co.il/api/automations/{id}/activation
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
Full reference, request and response samples
Activate/de-activate a given automation
PUT https://webapi.mymarketing.co.il/api/automations/{id}/activation
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
is_published | body | boolean | If the automation is published |
scheduled_time | body | date | Scheduled time for the automation activation |
The request body is a JSON object (ApiAutomationActivationInfo).
Full reference, request and response samples
Get all the types of actions that can be updated for a contact in an automation
GET https://webapi.mymarketing.co.il/api/automations/GetUpdateActions
No parameters.
Full reference, request and response samples
Send test campaigns from the given automation
POST https://webapi.mymarketing.co.il/api/automations/{id}/test
| Parameter | In | Type | Description |
|---|---|---|---|
id | path | integer | Automation id. Can be found using the endpoint "Get account's automations" or in the UI (go to Automations->Automations Lists->click on the automation's reports -> you'll find the id in the URL) Required. |
phone_numbers | body | Collection of string | The phone numbers to send the SMS test to. |
emails | body | Collection of string | The email addresses to send the email test to. |
The request body is a JSON object (ApiAutomationTestDetails).
Full reference, request and response samples
Get all the start trigger options for automations
GET https://webapi.mymarketing.co.il/api/automationtriggers/triggerTypes
No parameters.
Full reference, request and response samples
This reference is based on the ActiveTrail API documentation, where you can also test each endpoint with your own API key.