For more information on using API

GET http://webapi.mymarketing.co.il/api/automations/{id}/details

Get the details (excluding the steps) of a specific automation

Request Information

URI Parameters

Name

Description

Type

Additional information

id

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 int the URL)

integer

Required

Body Parameters

None.

Response Information

Resource Description

ApiAutomationDetailsInfo

Name

Description

Type

Additional information

name

Name of automation

string
allow_trigger_multiple_times

If a contact can go through the automation multipule times

boolean
prevent_simultaneous_automation_runs

If a contact can start the same automation multipule times simultaneously

boolean
report_interval_type

Interval type of report sending (0 / 12 / 24 /36 )

TypesAutomationReportIntervalTypes
report_send_to

Email address that will recieve the reports

string
is_send_report

If to send report

boolean
date_updated_utc

The UTC date when the automation was last updated

date
date_created_utc

The UTC date when the automation was created

date
extended_details

Object that contains the extended automation details (reruntrigger, etc.) See AutomationExtendedDetailsInfo for more information

ApiAutomationExtendedDetailsInfo

Response Formats

application/json, text/json

Sample: 
{
  "name": "sample string 1",
  "allow_trigger_multiple_times": true,
  "prevent_simultaneous_automation_runs": true,
  "report_interval_type": "Immediate",
  "report_send_to": "sample string 2",
  "is_send_report": true,
  "date_updated_utc": "2016-12-24T14:12:12",
  "date_created_utc": "2016-12-24T14:12:12",
  "extended_details": {
    "rerun_trigger": true,
    "working_days": [
      {
        "day": 1,
        "from": "00:00:00.1234567",
        "to": "00:00:00.1234567"
      },
      {
        "day": 1,
        "from": "00:00:00.1234567",
        "to": "00:00:00.1234567"
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<ApiAutomationDetailsInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Name>sample string 1</Name>
  <AllowTriggerMultipleTimes>true</AllowTriggerMultipleTimes>
  <PreventSimultaneousAutomationRuns>true</PreventSimultaneousAutomationRuns>
  <ReportIntervalType>Immediate</ReportIntervalType>
  <ReportSendTo>sample string 2</ReportSendTo>
  <IsSendReport>true</IsSendReport>
  <DateUpdatedUtc>2016-12-24T14:12:12</DateUpdatedUtc>
  <DateCreatedUtc>2016-12-24T14:12:12</DateCreatedUtc>
  <ExtendedDetailsInfo>
    <RerunTrigger>true</RerunTrigger>
    <WorkingDays>
      <ApiAutomationExtendedDetailsWorkingDays>
        <WorkingDay>1</WorkingDay>
        <FromHour />
        <ToHour />
      </ApiAutomationExtendedDetailsWorkingDays>
      <ApiAutomationExtendedDetailsWorkingDays>
        <WorkingDay>1</WorkingDay>
        <FromHour />
        <ToHour />
      </ApiAutomationExtendedDetailsWorkingDays>
    </WorkingDays>
  </ExtendedDetailsInfo>
</ApiAutomationDetailsInfo>