For more information on using API

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

Get the information of a specific push notification 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 automation data (including its' steps)" 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

ApiAutomationPushNotificationStepInfo

Name

Description

Type

Additional information

id

Step id

integer
push_name

Name of campaign

string

Required

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
campaign_id

Campaign id

globally unique identifier
title

string
subtitle

string
working_days

A list of the working days for the step

Collection of ApiAutomationExtendedDetailsWorkingDays

Response Formats

application/json, text/json

Sample: 
{
  "id": 1,
  "push_name": "sample string 1",
  "is_designed": true,
  "type": "EmailCampaign",
  "object_id": 1,
  "is_active": true,
  "step_type": "EmailCampaign",
  "campaign_id": "c3d8ac0c-dcdb-47b8-9307-2ebf31b88b83",
  "title": "sample string 4",
  "subtitle": "sample string 5",
  "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: 
<ApiAutomationPushNotificationStepInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <campaign_id>c3d8ac0c-dcdb-47b8-9307-2ebf31b88b83</campaign_id>
  <id>1</id>
  <is_active>true</is_active>
  <is_designed>true</is_designed>
  <object_id>1</object_id>
  <push_name>sample string 1</push_name>
  <step_type>EmailCampaign</step_type>
  <subtitle>sample string 5</subtitle>
  <title>sample string 4</title>
  <type>EmailCampaign</type>
  <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>
</ApiAutomationPushNotificationStepInfo>