Send Campaign

Test your campaign out and analyze the results to find out what time of day will bring you the most exposure and attention. Using this API, you can send campaigns in perfect timing.

Request Type

POST

Scope required

ZohoCampaigns.campaign.UPDATE

Other alternative scopes

ZohoCampaigns.campaign.CREATE-UPDATE (CREATE + UPDATE)
ZohoCampaigns.campaign.WRITE (CREATE + UPDATE + DELETE)
ZohoCampaigns.campaign.ALL (CREATE + UPDATE + DELETE + READ)

Header:

Authorization: Zoho-oauthtoken <access_token>

Content-Type: application/x-www-form-urlencoded

Request URL

https://campaigns.zoho.com/api/v1.1/sendcampaign

API Limit

Duration: 5 mins
Number of Calls: 500
Lock Period: 30 mins

You can send 500 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.

List of Parameters: -- Version 1.1

Parameter	Data Type	Description
resfmt	String	XML (or) JSON
campaignkey*	String	Get it from the recent campaign response

* - Mandatory Parameters

Sample XML Request

Copiedhttps://campaigns.zoho.com/api/v1.1/sendcampaign?resfmt=XML&campaignkey=[campaignkey]

Sample Response

Copied<response>
	<uri>/api/v1.1/sendcampaign</uri>
	<code>200</code>
	<version>1.1</version>
	<message></message>
	<campaign_status>inprogress</campaign_status>
</response>

Sample JSON Request

Copiedhttps://campaigns.zoho.com/api/v1.1/sendcampaign?resfmt=JSON&campaignkey=[campaignkey]

Sample Response

Copied{
  "response": {
    "uri": "/api/v1.1/sendcampaign",
    "code": "200",
    "version": "1.1",
    "message": "",
    "campaign_status": "inprogress"
  }
}