For more information on using API

POST http://webapi.mymarketing.co.il/api/automations

Create a new automation

Request Information

URI Parameters

Body Parameters

ApiAutomationInfo

Name

Description

Type

Additional information

id

Automation id

integer
template_id

The id of the template that was selected

integer
triggered_count

Number of times that a contact started the automation

integer
trigger_type_id

Trigger type from the triggers list

trigger_object_id

Id of the object that activates the trigger (email/ sign up form, etc.)

integer
segmentation_id

Segmentation id

integer
details

Object that contains the automation details (name, dates, etc.) See AutomationDetailsInfo for more information

design

Object that contains the automation design (data and flow steps.) See AutomationDesignInfo for more information

activation

Object that contains the automation activation (scheduled time for the automation and if it is active or not.) See AutomationActivationInfo for more information

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "template_id": 1,
  "triggered_count": 1,
  "trigger_type_id": "AbandonedCartRecovery",
  "trigger_object_id": 1,
  "segmentation_id": 1,
  "details": {
    "name": "sample string 1",
    "allow_trigger_multiple_times": 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"
  },
  "design": {
    "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
      }
    ]
  },
  "activation": {
    "is_published": true,
    "scheduled_time": "2016-12-24T14:12:12"
  }
}

application/xml, text/xml

Sample:
<ApiAutomationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <activation>
    <is_published>true</is_published>
    <scheduled_time>2016-12-24T14:12:12</scheduled_time>
  </activation>
  <design>
    <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>
  </design>
  <details>
    <allow_trigger_multiple_times>true</allow_trigger_multiple_times>
    <date_created_utc>2016-12-24T14:12:12</date_created_utc>
    <date_updated_utc>2016-12-24T14:12:12</date_updated_utc>
    <is_send_report>true</is_send_report>
    <name>sample string 1</name>
    <report_interval_type>Immediate</report_interval_type>
    <report_send_to>sample string 2</report_send_to>
  </details>
  <id>1</id>
  <segmentation_id>1</segmentation_id>
  <template_id>1</template_id>
  <trigger_object_id>1</trigger_object_id>
  <trigger_type_id>AbandonedCartRecovery</trigger_type_id>
  <triggered_count>1</triggered_count>
</ApiAutomationInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiAutomationInfo

Name

Description

Type

Additional information

id

Automation id

integer
template_id

The id of the template that was selected

integer
triggered_count

Number of times that a contact started the automation

integer
trigger_type_id

Trigger type from the triggers list

trigger_object_id

Id of the object that activates the trigger (email/ sign up form, etc.)

integer
segmentation_id

Segmentation id

integer
details

Object that contains the automation details (name, dates, etc.) See AutomationDetailsInfo for more information

design

Object that contains the automation design (data and flow steps.) See AutomationDesignInfo for more information

activation

Object that contains the automation activation (scheduled time for the automation and if it is active or not.) See AutomationActivationInfo for more information

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "template_id": 1,
  "triggered_count": 1,
  "trigger_type_id": "AbandonedCartRecovery",
  "trigger_object_id": 1,
  "segmentation_id": 1,
  "details": {
    "name": "sample string 1",
    "allow_trigger_multiple_times": 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"
  },
  "design": {
    "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
      }
    ]
  },
  "activation": {
    "is_published": true,
    "scheduled_time": "2016-12-24T14:12:12"
  }
}

application/xml, text/xml

Sample:
<ApiAutomationInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <activation>
    <is_published>true</is_published>
    <scheduled_time>2016-12-24T14:12:12</scheduled_time>
  </activation>
  <design>
    <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>
  </design>
  <details>
    <allow_trigger_multiple_times>true</allow_trigger_multiple_times>
    <date_created_utc>2016-12-24T14:12:12</date_created_utc>
    <date_updated_utc>2016-12-24T14:12:12</date_updated_utc>
    <is_send_report>true</is_send_report>
    <name>sample string 1</name>
    <report_interval_type>Immediate</report_interval_type>
    <report_send_to>sample string 2</report_send_to>
  </details>
  <id>1</id>
  <segmentation_id>1</segmentation_id>
  <template_id>1</template_id>
  <trigger_object_id>1</trigger_object_id>
  <trigger_type_id>AbandonedCartRecovery</trigger_type_id>
  <triggered_count>1</triggered_count>
</ApiAutomationInfo>