For more information on using API

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

Add an WhatsApp campaign step in the automation

Request Information

URI Parameters

Name

Description

Type

Additional information

id

Automation id

integer

Required

Body Parameters

ApiAutomationWhatsAppStepUpdateInfo

Name

Description

Type

Additional information

campaign_name

Campaign name

string

Required

user_whatsapp_profile_id

User WhatsApp Profile Id

integer

Required

from_name

From name

string

Required

content

Message content

string

Required

is_link_tracking

If the links are tracked

boolean
unsubscribe_text

Unsbscribe test to add to link

string
is_active

If the step is active

boolean

Required

working_days

template_id

string
campaign_id

globally unique identifier
campaign_type

file_path

string

Request Formats

application/json, text/json

Sample:
{
  "campaign_name": "sample string 1",
  "user_whatsapp_profile_id": 2,
  "from_name": "sample string 3",
  "content": "sample string 4",
  "is_link_tracking": true,
  "unsubscribe_text": "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"
    }
  ],
  "template_id": "sample string 8",
  "campaign_id": "b0d572a8-5d5c-4096-b1c7-bff6a10f42b1",
  "campaign_type": 1,
  "file_path": "sample string 10"
}

application/xml, text/xml

Sample:
<ApiAutomationWhatsAppStepUpdateInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <campaign_id>b0d572a8-5d5c-4096-b1c7-bff6a10f42b1</campaign_id>
  <campaign_name>sample string 1</campaign_name>
  <campaign_type>Template</campaign_type>
  <content>sample string 4</content>
  <file_path>sample string 10</file_path>
  <from_name>sample string 3</from_name>
  <is_active>true</is_active>
  <is_link_tracking>true</is_link_tracking>
  <template_id>sample string 8</template_id>
  <unsubscribe_text>sample string 6</unsubscribe_text>
  <user_whatsapp_profile_id>2</user_whatsapp_profile_id>
  <working_days xmlns:d2p1="http://schemas.datacontract.org/2004/07/ActiveTrail.BusinessLogic.Automations.Models">
    <d2p1:AutomationExtendedDetailsWorkingDays>
      <d2p1:day>1</d2p1:day>
      <d2p1:from>PT0.1234567S</d2p1:from>
      <d2p1:to>PT0.1234567S</d2p1:to>
    </d2p1:AutomationExtendedDetailsWorkingDays>
    <d2p1:AutomationExtendedDetailsWorkingDays>
      <d2p1:day>1</d2p1:day>
      <d2p1:from>PT0.1234567S</d2p1:from>
      <d2p1:to>PT0.1234567S</d2p1:to>
    </d2p1:AutomationExtendedDetailsWorkingDays>
  </working_days>
</ApiAutomationWhatsAppStepUpdateInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiAutomationWhatsAppStepInfo

Name

Description

Type

Additional information

campaign_name

Campaign name

string

Required

user_whatsapp_profile_id

User WhatsApp Profile Id

integer

Required

from_name

From name

string

Required

content

Message content

string

Required

is_link_tracking

If the links are tracked

boolean
unsubscribe_text

Unsbscribe test to add to link

string
id

Step id

integer
type

Step type from list

object_id

Sms campaign id

integer
working_days

A list of the working days for the step

campaign_id

Campaign id

globally unique identifier
template_id

Template id

string
campaign_type

Campaign type

file_path

File path

string

Response Formats

application/json, text/json

Sample:
{
  "campaign_name": "sample string 1",
  "user_whatsapp_profile_id": 2,
  "from_name": "sample string 3",
  "content": "sample string 4",
  "is_link_tracking": true,
  "unsubscribe_text": "sample string 6",
  "id": 1,
  "type": "EmailCampaign",
  "object_id": 1,
  "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"
    }
  ],
  "campaign_id": "691465e1-0ee6-44d6-953e-24dd88d823f2",
  "template_id": "sample string 8",
  "campaign_type": 1,
  "file_path": "sample string 9"
}

application/xml, text/xml

Sample:
<ApiAutomationWhatsAppStepInfo xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <campaign_id>691465e1-0ee6-44d6-953e-24dd88d823f2</campaign_id>
  <campaign_name>sample string 1</campaign_name>
  <campaign_type>Template</campaign_type>
  <content>sample string 4</content>
  <file_path>sample string 9</file_path>
  <from_name>sample string 3</from_name>
  <id>1</id>
  <is_link_tracking>true</is_link_tracking>
  <object_id>1</object_id>
  <template_id>sample string 8</template_id>
  <type>EmailCampaign</type>
  <unsubscribe_text>sample string 6</unsubscribe_text>
  <user_whatsapp_profile_id>2</user_whatsapp_profile_id>
  <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>
</ApiAutomationWhatsAppStepInfo>