For more information on using API

GET https://webapi.mymarketing.co.il/api/automations/{id}/design

Get the JSON that represents the design of the automation flow in the UI including the data of the given 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

ApiAutomationDesignInfo

Name

Description

Type

Additional information

data

JSON data that represent the UI in the builder in the web appli\cation

string
stepsInfo

List of automation flow steps

Response Formats

application/json, text/json

Sample:
{
  "data": "sample string 1",
  "stepsInfo": [
    {
      "id": 1,
      "type": "EmailCampaign",
      "object_id": 1,
      "is_active": true
    },
    {
      "id": 1,
      "type": "EmailCampaign",
      "object_id": 1,
      "is_active": true
    }
  ]
}

application/xml, text/xml

Sample:
<ApiAutomationDesignInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <data>sample string 1</data>
  <stepsInfo>
    <ApiAutomationStepDesignInfo>
      <id>1</id>
      <is_active>true</is_active>
      <object_id>1</object_id>
      <type>EmailCampaign</type>
    </ApiAutomationStepDesignInfo>
    <ApiAutomationStepDesignInfo>
      <id>1</id>
      <is_active>true</is_active>
      <object_id>1</object_id>
      <type>EmailCampaign</type>
    </ApiAutomationStepDesignInfo>
  </stepsInfo>
</ApiAutomationDesignInfo>