For more information on using API

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

Get the information of a specific email step in 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

stepId

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

integer

Required

Body Parameters

None.

Response Information

Resource Description

ApiAutomationEmailStepInfo

Name

Description

Type

Additional information

email_name

Name of campaign

string

Required

user_profile_id

Send profile id

integer

Required

email_subject

Campaign subject

string

Required

preheader

Preheader

string
attachment_file_name

Attachment file name

string
attachment_file_url

Attachement url

string
id

Step id

integer
is_designed

If the campaign in the automation step is designd and saved

boolean
type

Type of step from list

TypesAutomationStepTypes
object_id

Campaign id

integer
is_active

If the step is active

boolean

Required

step_type

Type of step from list

TypesAutomationStepTypes
working_days

A list of the working days for the step

Collection of ApiAutomationExtendedDetailsWorkingDays

Response Formats

application/json, text/json

Sample: 
{
  "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",
  "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: 
<ApiAutomationEmailStepInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <attachment_file_name>sample string 5</attachment_file_name>
  <attachment_file_url>sample string 6</attachment_file_url>
  <email_name>sample string 1</email_name>
  <email_subject>sample string 3</email_subject>
  <id>1</id>
  <is_active>true</is_active>
  <is_designed>true</is_designed>
  <object_id>1</object_id>
  <preheader>sample string 4</preheader>
  <step_type>EmailCampaign</step_type>
  <type>EmailCampaign</type>
  <user_profile_id>2</user_profile_id>
  <working_days>
    <ApiAutomationExtendedDetailsWorkingDays>
      <day>1</day>
      <from>PT0.1234567S</from>
      <to>PT0.1234567S</to>
    </ApiAutomationExtendedDetailsWorkingDays>
    <ApiAutomationExtendedDetailsWorkingDays>
      <day>1</day>
      <from>PT0.1234567S</from>
      <to>PT0.1234567S</to>
    </ApiAutomationExtendedDetailsWorkingDays>
  </working_days>
</ApiAutomationEmailStepInfo>