Schedule Campaign

Schedule Campaign

Users can schedule campaigns using the following API.

Request URL

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

Request Type: Post

List of 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

am_pm*

String

Set am or pm

istimewarp

Boolean

Set to sender's time zone

sendingTZ

String

Set to recipient's 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" }

Possible error cases

Error code Description
3023AB campaign cannot be sent to less than 4 recipients.
6607No Content for this campaign.
6606No lists selected for this campaign.
6605Campaign status is changed.
6609Content changed after review.
6608Recipient changed after review.
6611Content is not reviewed.
6604Error in campaign sending. Shopify setup error
6603Error in Campaign Sending. Coupon setup error.
903Mandatory fields are missing.
6600Campaign is sent.
6503Campaign has been deleted.
6302There are no details in this campaign.
6601Insufficient privileges to perform this action. Please contact the org admin.
6301Invalid campaign key.
1004Invalid URL for content import.

If your error code is not listed above,click here.

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocampaigns.com