Manage And Connect Using APIs

Recent Campaigns

Users can view the recent campaigns using our API authentication token.

Request URL

XML/ JSON

https://campaigns.zoho.com/api/recentcampaigns

Request Type:  Get/ Post

Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

version

String

This will fetch responses based on the current API version.

resfmt

String

XML (or) JSON

sort

String

asc/desc

fromindex

 

number

Default value: 1

range

 

number

number

 

status

String

all|all campaigns|drafts|scheduled|inprogress|sent|stopped| canceled|tobereviewed|reviewed|paused|intesting

 

* - Mandatory Parameters

Sample Request:

XML/ JSON

https://campaigns.zoho.com/api/recentcampaigns?authtoken=[API Authentication Token]&scope=[CampaignsAPI]&sort=[asc/desc]&fromindex=[number]&range=[number]&status=[all|all campaigns|drafts|scheduled|inprogress|sent|stopped|canceled|tobereviewed|reviewed|paused|intesting]

Sample Response:

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

XML Format:

<response uri="https://campaigns.zoho.com/api/recentcampaigns" version="1">

<status>success</status>

<code>0</code>

<range>5</range>

<status>All</status>

<fromindex>1</fromindex>

<recent-campaigns>

<campaign no="1">

<fl val="campaign_key">f70c4878c4a47169407e63917ad24497</fl>

<fl val="campaign_name">1222</fl>

<fl val="created_date_string">19 Aug 2013, 11:26 AM</fl>

<fl val="campaign_status">Draft</fl>

<fl val="created_time">1376920587000</fl>

<fl val="campaign_preview">

campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023454038

</fl>

</campaign>

<campaign no="2">

<fl val="campaign_key">f70c4878c4a47169cff121e4406fc65f</fl>

<fl val="campaign_name">4654</fl>

<fl val="created_date_string">16 Aug 2013, 08:03 PM</fl>

<fl val="campaign_status">Draft</fl>

<fl val="created_time">1376692411000</fl>

<fl val="campaign_preview">

campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023454002

</fl>

</campaign>

<campaign no="3">

<fl val="campaign_key">f70c4878c4a4716956b069688d2a58be</fl>

<fl val="campaign_name">outlok</fl>

<fl val="created_date_string">16 Aug 2013, 09:23 PM</fl>

<fl val="campaign_status">Draft</fl>

<fl val="created_time">1376697194000</fl>

<fl val="campaign_preview">

campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023453108

</fl>

</campaign>

<campaign no="4">

<fl val="campaign_key">f70c4878c4a4716978fcc0ef91b933a3</fl>

<fl val="campaign_name">t1</fl>

<fl val="created_date_string">16 Aug 2013, 09:12 PM</fl>

<fl val="campaign_status">Draft</fl>

<fl val="created_time">1376696522000</fl>

<fl val="campaign_preview">

campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023453086

</fl>

</campaign>

<campaign no="5">

<fl val="campaign_key">f70c4878c4a47169613e476aed11106d</fl>

<fl val="campaign_name">21313</fl>

<fl val="created_date_string">16 Aug 2013, 09:04 PM</fl>

<fl val="campaign_status">Draft</fl>

<fl val="created_time">1376696048000</fl>

<fl val="campaign_preview">

campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023453072

</fl>

</campaign>

</recent-campaigns>

</response>

JSON format:

{"requestdetails":"{range=5, status=All, fromindex=1}","status":"success","recent_campaigns":[{"campaign_key":"f70c4878c4a47169407e63917ad24497","campaign_name":"1222","created_date_string":"19 Aug 2013, 11:26 AM","campaign_status":"Draft","created_time":"1376920587000","campaign_preview":"campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023454038"},{"campaign_key":"f70c4878c4a47169cff121e4406fc65f","campaign_name":"4654","created_date_string":"16 Aug 2013, 08:03 PM","campaign_status":"Draft","created_time":"1376692411000","campaign_preview":"campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023454002"},{"campaign_key":"f70c4878c4a4716956b069688d2a58be","campaign_name":"outlok","created_date_string":"16 Aug 2013, 09:23 PM","campaign_status":"Draft","created_time":"1376697194000","campaign_preview":"campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023453108"},{"campaign_key":"f70c4878c4a4716978fcc0ef91b933a3","campaign_name":"t1","created_date_string":"16 Aug 2013, 09:12 PM","campaign_status":"Draft","created_time":"1376696522000","campaign_preview":"campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023453086"},{"campaign_key":"f70c4878c4a47169613e476aed11106d","campaign_name":"21313","created_date_string":"16 Aug 2013, 09:04 PM","campaign_status":"Draft","created_time":"1376696048000","campaign_preview":"campaigns.zoho.com/EmailDisplayAction.do?&campaignId=303000023453072"}],"code":"0","uri":"/api/recentcampaigns","version":"1"}

Top