For more information on using API

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

Get all the 'send email' steps in a 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

ApiAutomationEmailStepInfoList

Name

Description

Type

Additional information

total_items

Total steps count

integer
automations_emails_steps_info

List of automation steps

Collection of ApiAutomationEmailStepInfo

Response Formats

application/json, text/json

Sample: 
{
  "total_items": 1,
  "automations_emails_steps_info": [
    {
      "email_name": "sample string 1",
      "user_profile_id": 2,
      "email_subject": "sample string 3",
      "preheader": "sample string 4",
      "attachment_file_name": "sample string 5",
      "attachment_file_url": "sample string 6",
      "id": 1,
      "is_designed": true,
      "type": "EmailCampaign",
      "object_id": 1,
      "is_active": true,
      "step_type": "EmailCampaign",
      "analytics_campaign_name": "sample string 8",
      "add_analytics_tracking_to_links": 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"
        }
      ],
      "holidays": {
        "countries": [
          "sample string 1",
          "sample string 2"
        ],
        "timeZone": "sample string 1"
      }
    },
    {
      "email_name": "sample string 1",
      "user_profile_id": 2,
      "email_subject": "sample string 3",
      "preheader": "sample string 4",
      "attachment_file_name": "sample string 5",
      "attachment_file_url": "sample string 6",
      "id": 1,
      "is_designed": true,
      "type": "EmailCampaign",
      "object_id": 1,
      "is_active": true,
      "step_type": "EmailCampaign",
      "analytics_campaign_name": "sample string 8",
      "add_analytics_tracking_to_links": 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"
        }
      ],
      "holidays": {
        "countries": [
          "sample string 1",
          "sample string 2"
        ],
        "timeZone": "sample string 1"
      }
    }
  ]
}

application/xml, text/xml

Sample: 
<ApiAutomationEmailStepInfoList xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <TotalItems>1</TotalItems>
  <AutomationsEmailsStepsInfo>
    <ApiAutomationEmailStepInfo>
      <EmailName>sample string 1</EmailName>
      <UserProfileId>2</UserProfileId>
      <EmailSubject>sample string 3</EmailSubject>
      <Preheader>sample string 4</Preheader>
      <AttachmentFileName>sample string 5</AttachmentFileName>
      <AttachmentFileUrl>sample string 6</AttachmentFileUrl>
      <Id>1</Id>
      <IsDesigned>true</IsDesigned>
      <Type>EmailCampaign</Type>
      <ObjectId>1</ObjectId>
      <IsActive>true</IsActive>
      <StepType>EmailCampaign</StepType>
      <GoogleAnalytics>sample string 8</GoogleAnalytics>
      <AddAnalyticsTrackingToLinks>true</AddAnalyticsTrackingToLinks>
      <WorkingDays>
        <ApiAutomationExtendedDetailsWorkingDays>
          <WorkingDay>1</WorkingDay>
          <FromHour />
          <ToHour />
        </ApiAutomationExtendedDetailsWorkingDays>
        <ApiAutomationExtendedDetailsWorkingDays>
          <WorkingDay>1</WorkingDay>
          <FromHour />
          <ToHour />
        </ApiAutomationExtendedDetailsWorkingDays>
      </WorkingDays>
      <Holidays>
        <Countries>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </Countries>
        <TimeZone>sample string 1</TimeZone>
      </Holidays>
    </ApiAutomationEmailStepInfo>
    <ApiAutomationEmailStepInfo>
      <EmailName>sample string 1</EmailName>
      <UserProfileId>2</UserProfileId>
      <EmailSubject>sample string 3</EmailSubject>
      <Preheader>sample string 4</Preheader>
      <AttachmentFileName>sample string 5</AttachmentFileName>
      <AttachmentFileUrl>sample string 6</AttachmentFileUrl>
      <Id>1</Id>
      <IsDesigned>true</IsDesigned>
      <Type>EmailCampaign</Type>
      <ObjectId>1</ObjectId>
      <IsActive>true</IsActive>
      <StepType>EmailCampaign</StepType>
      <GoogleAnalytics>sample string 8</GoogleAnalytics>
      <AddAnalyticsTrackingToLinks>true</AddAnalyticsTrackingToLinks>
      <WorkingDays>
        <ApiAutomationExtendedDetailsWorkingDays>
          <WorkingDay>1</WorkingDay>
          <FromHour />
          <ToHour />
        </ApiAutomationExtendedDetailsWorkingDays>
        <ApiAutomationExtendedDetailsWorkingDays>
          <WorkingDay>1</WorkingDay>
          <FromHour />
          <ToHour />
        </ApiAutomationExtendedDetailsWorkingDays>
      </WorkingDays>
      <Holidays>
        <Countries>
          <string>sample string 1</string>
          <string>sample string 2</string>
        </Countries>
        <TimeZone>sample string 1</TimeZone>
      </Holidays>
    </ApiAutomationEmailStepInfo>
  </AutomationsEmailsStepsInfo>
</ApiAutomationEmailStepInfoList>