Schedule Campaign

Users can schedule campaigns using the following API.

Request URL

https://campaigns.zoho.com/api/sendcampaign?isschedule=true

Request Type: Post

Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

resfmt

String

xml (or) json

campaignkey

String

Get it from the recent campaign response

scheduledate

mm/dd/yyyy

Provide a date to schedule campaign

schedulehour

[1-12]

Give a preferred time

scheduleminute

[00-55]

Give a preferred time

sendingtz

am_pm

Set a time zone

* - Mandatory Parameters

Sample Request:

https://campaigns.zoho.com/api/sendcampaign?isschedule=true&authtoken=[Authentication token]&scope=CampaignsAPI&resfmt=XML&campaignkey=[campaignkey]&scheduleDate=01/19/2017&scheduleHour=12&scheduleMinute=15&am_pm=PM&sendingTZ=Asia/Kolkata ​

Sample Response:

Our API response will let you know of the following be it in the XML or JSON format.

XML Format:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>

<response> <message>Success</message>

<campaign_status>ScheduledAfterReviewed</campaign_status>

<code>200</code>

<uri>/api/sendcampaign</uri>

<version>1</version> </response>

JSON format:

{ "message": "Success", "campaign_status": "ScheduledAfterReviewed", "code": "200", "uri": "/api/sendcampaign", "version": "1" }