For more information on using API

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

Get the information of a specific 'notify someone' 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)"

integer

Required

Body Parameters

None.

Response Information

Resource Description

ApiAutomationNotifyStepInfo

Name

Description

Type

Additional information

id

Step id

integer
object_id

Not in use here

integer
type

Type from list

emails

Step type from list

Collection of string
is_active

If the step is active

boolean

Required

user_api_event_ids

The web-hook ids

Collection of integer

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "object_id": 1,
  "type": "EmailCampaign",
  "emails": [
    "sample string 1",
    "sample string 2"
  ],
  "is_active": true,
  "user_api_event_ids": [
    1,
    2
  ]
}

application/xml, text/xml

Sample:
<ApiAutomationNotifyStepInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </emails>
  <id>1</id>
  <is_active>true</is_active>
  <object_id>1</object_id>
  <type>EmailCampaign</type>
  <user_api_event_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </user_api_event_ids>
</ApiAutomationNotifyStepInfo>