For more information on using API

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

Add an email campaign step in the automation

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Automation id

integer

Required

Body Parameters

ApiAutomationEmailStepUpdateInfo

Name

Description

Type

Additional information

email_name

Email name

string

Required

user_profile_id

Sending profile id from list

integer

Required

email_subject

Campaign subject

string

Required

preheader

Preheader

string
attachment_file_name

Attachment file name

string
attachment_file_url

Attachement url

string
is_active

If the step is active

boolean

Required

Request 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",
  "is_active": true
}

application/xml, text/xml

Sample:
<ApiAutomationEmailStepUpdateInfo 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>
  <is_active>true</is_active>
  <preheader>sample string 4</preheader>
  <user_profile_id>2</user_profile_id>
</ApiAutomationEmailStepUpdateInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

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

object_id

Campaign id

integer
is_active

If the step is active

boolean

Required

step_type

Type of step from list

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"
}

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>
</ApiAutomationEmailStepInfo>