For more information on using API

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

Update an email campaign step in a 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

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

working_days

Collection of AutomationExtendedDetailsWorkingDays
analytics_campaign_name

analytics campaign name

string
add_analytics_tracking_to_links

add_analytics_tracking_to_links

boolean

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,
  "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"
    }
  ],
  "analytics_campaign_name": "sample string 8",
  "add_analytics_tracking_to_links": true
}

application/xml, text/xml

Sample: 
<ApiAutomationEmailStepUpdateInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <EmailName>sample string 1</EmailName>
  <UserProfileId>2</UserProfileId>
  <EmailSubject>sample string 3</EmailSubject>
  <Preheader>sample string 4</Preheader>
  <AttachmentFileName>sample string 5</AttachmentFileName>
  <AttachmentFileUrl>sample string 6</AttachmentFileUrl>
  <IsActive>true</IsActive>
  <WorkingDays>
    <AutomationExtendedDetailsWorkingDays>
      <WorkingDay>1</WorkingDay>
      <FromHour />
      <ToHour />
    </AutomationExtendedDetailsWorkingDays>
    <AutomationExtendedDetailsWorkingDays>
      <WorkingDay>1</WorkingDay>
      <FromHour />
      <ToHour />
    </AutomationExtendedDetailsWorkingDays>
  </WorkingDays>
  <GoogleAnalytics>sample string 8</GoogleAnalytics>
  <AddAnalyticsTrackingToLinks>true</AddAnalyticsTrackingToLinks>
</ApiAutomationEmailStepUpdateInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

None.