How can we help?

/campaignmanager/run

<base-url>/campaignmanager/run.[xml|json]
Example: https://127.0.0.1:7000/campaignmanager/run.json

Use this URL to run a campaign on the server. A campaign will send multiple messages at once from a predefined data source.

The following arguments are available:

Property Type Description
ID String The Campaign ID of the campaign to run
CustomSmsMessage String A customized SMS message to use for this campaign. Leave empty to use the default SMS message defined for this campaign.
CustomPlainTextMessage String A customized plain text message for this campaign. This applies to E-mail campaigns. Leave empty to use the default plain text message for this campaign.
CustomHtmlMessage String A customized HTML message for this campaign. This applies to E-mail campaigns. Leave empty to use the default HTML message for this campaign.
CustomSubject String A customized E-mail subject for this campaign. This applies to E-mail campaigns. Leave empty to use the default subject for this campaign.
BatchDescription String Enter a batch description to create a new batch ID for this campaign run

Post body

This example sends a campaign with a customized message. The batch description is set so a new batch id will be generated for this batch run. This same batch id number will be set for each message sent int this run.

{
    "ID": "CAMPAIGN1"
  , "CustomSmsMessage": "Hi %Name%; Sending a customized message"
  , "BatchDescription": "Send using batchid"
}
<run>
  <ID>CAMPAIGN1</ID>
  <CustomSmsMessage>Hi %Name%; Sending a customized message</CustomSmsMessage>
  <BatchDescription>Send using batchid</BatchDescription>
</run>

Response body

The response body included the batch id as well as the total number of messages created.

{
   "result":[
      {
         "LastError":0,
         "LastErrorDescription":"Success",
         "BatchID":56,
         "Count":3
      }
   ]
}
<response>
  <result>
    <LastError>0</LastError>
    <LastErrorDescription>Success</LastErrorDescription>
    <BatchID>55</BatchID>
    <Count>3</Count>
  </result>
</response>