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

MethodEndpointWhat it does
GET/api/automations/{id}Get an automation's information by its ID
GET/api/automationsGet account's automations
DELETE/api/automations/{ids}Delete the given automation
GET/api/automations/{id}/DateEventTriggerDataGet trigger's information of a specific "contact celebrates a date" automation
GET/api/automations/{id}/triggerInfoGet a specific automation's trigger information
GET/api/automations/{id}/detailsGet the details (excluding the steps) of a specific automation
PUT/api/automations/{id}/detailsUpdate the setup of the given automation
GET/api/automations/{id}/chartDataGet the JSON that represents the design of the automation flow in the UI
GET/api/automations/{id}/designGet the automation flow design, including its steps
GET/api/automations/{id}/FlowTimesStartedGet the automation's steps flow
GET/api/automations/{id}/AutomationStepReportDetails/{stepId}Getting report details for given step
GET/api/automations/{id}/Steps/{stepId}Get a certain automation step information in the given automation
GET/api/automations/{id}/EmailCampaignStepsGet all the 'send email' steps in a given automation
GET/api/automations/{id}/EmailCampaignSteps/{stepId}Get the information of a specific email step in the given automation
PUT/api/automations/{id}/EmailCampaignSteps/{stepId}Update an email campaign step in a given automation
GET/api/automations/{id}/SMSCampaignStepsGet all the 'send SMS' steps in a given automation
GET/api/automations/{id}/SMSCampaignSteps/{stepId}Get the information of a specific SMS step in the given automation
PUT/api/automations/{id}/SMSCampaignSteps/{stepId}Update an SMS campaign step in the automation
GET/api/automations/{id}/WhatsAppCampaignSteps/{stepId}Get the information of a specific Whatsapp step in the given automation
GET/api/automations/{id}/PushNotificationSteps/{stepId}Get the information of a specific push notification step in the given automation
GET/api/automations/{id}/ContactUpdateSteps/{stepId}Get the information of a specific 'contact update' step in the given automation
GET/api/automations/{id}/SocialSteps/{stepId}Get the information of a specific Social step in the given automation
GET/api/automations/{id}/ABSplitSteps/{stepId}Get the information of a specific A/B split step in the given automation
GET/api/automations/{id}/NotifySteps/{stepId}Get the information of a specific 'notify someone' step in the given automation
GET/api/automations/{id}/activationGet the activation status of the given automation
PUT/api/automations/{id}/activationActivate/de-activate a given automation
GET/api/automations/GetUpdateActionsGet all the types of actions that can be updated for a contact in an automation
POST/api/automations/{id}/testSend test campaigns from the given automation
GET/api/automationtriggers/triggerTypesGet 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}
ParameterInTypeDescription
idpathintegerAutomation 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
ParameterInTypeDescription
state_typequeryTypesAutomationStateTypesGet status type from list
pagequeryintegerGet a specific page (number of pages is limited) (Range: inclusive between 1 and 2147483647)
limitqueryintegerLimit 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 (',')

ParameterInTypeDescription
idspathstringstring 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.

ParameterInTypeDescription
idpathintegerAutomation 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
ParameterInTypeDescription
idpathintegerAutomation 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
ParameterInTypeDescription
idpathintegerAutomation 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
ParameterInTypeDescription
idpathintegerAutomation 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.
namebodystringName of automation
allow_trigger_multiple_timesbodybooleanIf a contact can go through the automation multipule times
prevent_simultaneous_automation_runsbodybooleanIf a contact can start the same automation multipule times simultaneously
report_interval_typebodyTypesAutomationReportIntervalTypesInterval type of report sending (0 / 12 / 24 /36 )
report_send_tobodystringEmail address that will receive the reports
is_send_reportbodybooleanIf to send report
date_updated_utcbodydateThe UTC date when the automation was last updated
date_created_utcbodydateThe UTC date when the automation was created
extended_detailsbodyApiAutomationExtendedDetailsInfoObject 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)

ParameterInTypeDescription
idpathintegerAutomation 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).

ParameterInTypeDescription
idpathintegerAutomation 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
ParameterInTypeDescription
idpathintegerAutomation 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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
ParameterInTypeDescription
idpathintegerAutomation 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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_namebodystringEmail name Required.
user_profile_idbodyintegerSending profile id from list Required.
email_subjectbodystringCampaign subject Required.
preheaderbodystringPreheader
attachment_file_namebodystringAttachment file name
attachment_file_urlbodystringAttachement url
is_activebodybooleanIf the step is active Required.
working_daysbodyCollection of AutomationExtendedDetailsWorkingDays
holidaysbodyAutomationExtendedDetailsHolidays
analytics_campaign_namebodystringanalytics campaign name
add_analytics_tracking_to_linksbodybooleanadd_analytics_tracking_to_links
add_statisticsbodybooleanAllow 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
ParameterInTypeDescription
idpathintegerAutomation 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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_namebodystringCampaign name Required.
user_sms_profile_idbodyintegerUser Sms Profile Id Required.
from_namebodystringFrom name Required.
contentbodystringMessage content Required.
is_link_trackingbodybooleanIf the links are tracked
unsubscribe_textbodystringUnsubscribe text to add to link
is_activebodybooleanIf the step is active Required.
working_daysbodyCollection of AutomationExtendedDetailsWorkingDays
holidaysbodyAutomationExtendedDetailsHolidays

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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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}
ParameterInTypeDescription
idpathintegerAutomation 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.
stepIdpathintegerStep 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
ParameterInTypeDescription
idpathintegerAutomation 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
ParameterInTypeDescription
idpathintegerAutomation 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_publishedbodybooleanIf the automation is published
scheduled_timebodydateScheduled 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
ParameterInTypeDescription
idpathintegerAutomation 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_numbersbodyCollection of stringThe phone numbers to send the SMS test to.
emailsbodyCollection of stringThe 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.