For more information on using API

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

Get the information of a specific 'contact update' 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

ApiAutomationContactStepInfo

Name

Description

Type

Additional information

id

Step id

integer
object_id

Not in use here

integer
type

Type from list

action_type

Action type

entity_id

Group id / Field id

integer
entity_value

Value to update

string
is_active

If the step is active

boolean

Required

Response Formats

application/json, text/json

Sample:
{
  "id": 1,
  "object_id": 1,
  "type": "EmailCampaign",
  "action_type": "AddToGroup",
  "entity_id": 1,
  "entity_value": "sample string 1",
  "is_active": true
}

application/xml, text/xml

Sample:
<ApiAutomationContactStepInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <action_type>AddToGroup</action_type>
  <entity_id>1</entity_id>
  <entity_value>sample string 1</entity_value>
  <id>1</id>
  <is_active>true</is_active>
  <object_id>1</object_id>
  <type>EmailCampaign</type>
</ApiAutomationContactStepInfo>