For more information on using API

POST https://webapi.mymarketing.co.il/api/automations/{id}/test

Send test campaigns from 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

Body Parameters

ApiAutomationTestDetails

Name

Description

Type

Additional information

phone_numbers

string emails seperated by comma (',')

Collection of string
emails

string phone numbers seperated by comma (',')

Collection of string

Request Formats

application/json, text/json

Sample: 
{
  "phone_numbers": [
    "sample string 1",
    "sample string 2"
  ],
  "emails": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<ApiAutomationTestDetails 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>
  <phone_numbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </phone_numbers>
</ApiAutomationTestDetails>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AutomationTestResults

Name

Description

Type

Additional information

total_sms_sent

integer
total_email_sent

integer
total_whatsapp_sent

integer

Response Formats

application/json, text/json

Sample: 
{
  "total_sms_sent": 1,
  "total_email_sent": 2,
  "total_whatsapp_sent": 3
}

application/xml, text/xml

Sample: 
<AutomationTestResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ActiveTrail.RESTfulApi.Models">
  <total_email_sent>2</total_email_sent>
  <total_sms_sent>1</total_sms_sent>
  <total_whatsapp_sent>3</total_whatsapp_sent>
</AutomationTestResults>