ScheduleCampaign
Schedule the campaign.
URL | https://api.enginemailer.com/restapi/campaign/emcampaign/ScheduleCampaign |
Method | HTTP GET with Query String |
Please note of the following before starting use this function
- Scheduled, delivering, delivered campaign is not able to perform the scheduling.
- This function will not work when the campaign is deleting the recipient list.
- The campaign must at least have one recipient to deliver the campaign.
- Schedule Date must not be a passed date.
- Schedule Date must follow the standard of scheduling in the portal. It must be in the interval of 15 minutes. For g., 12:00, 12:15, 12:30, 12:45, others format of the schedule time will be rejected.
- Insufficient credit will flag the scheduled campaign as “failed” and campaign will not send at the scheduled time. Failed campaign can be edited and resend from the portal.
Table: Parameter
Parameter name | Description | Column Type |
---|---|---|
CampaignID | Targeted Campaign ID. | Integer |
ScheduleTime |
Schedule Time. Format: ddMMyyyy hh:mmtt For example, 01122018 12:15PM |
String |
Request Example
Header
<APIKEY> - Value
Response
Success Response
{
"Result":{
"Status":"OK",
"StatusCode":"200"
}
}
Failed Response
{
"Result":{
"StatusCode":"500",
"Status":"InternalServerError",
"ErrorMessage":"Authentication Failed!"
}
}
Code Example (.NET)
Using REST SHARP library , please download from Nuget Package
var client = new RestClient("https://api.enginemailer.com/restapi/campaign/emcampaign/ScheduleCampaign?campaignid=1&scheduletime=30042018 03:00PM"); var request = new RestRequest(Method.GET); request.AddHeader("APIKey", "YOUR API KEY"); var response = client.Execute(request).Content; var response2 = JObject.Parse(response);