Recent campaigns

Using this API, you can see the details of the five most recent campaigns that has been created in your organization.

Scope required

  • ZohoMarketingAutomation.campaign.READ

Other alternative scopes

  • ZohoMarketingAutomation.campaign.ALL (CREATE + UPDATE + DELETE + READ)

    Header:

    Authorization: Zoho-oauthtoken <access_token>

    Request type:

    • Get/ Post

    Request URL

    https://marketingautomation.zoho.com/api/v1/recentcampaigns

    List of parameters

    Parameter

    Data type

    Description

    resfmt

    String

     JSON

    sort

    String

    asc/desc

    fromindex

    number

    Default value: 1

    range

    number

    number

    status

    String

    To be separated by '|' symbol in request.

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

    * - Mandatory parameters

    Possible error cases

    Error code

    Description

    2206

    Campaign has been deleted.

    6101

    No campaign was sent.

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

    Sample request

    Copiedhttps://marketingautomation.zoho.com/api/v1/recentcampaigns?sort=[asc/desc]&fromindex=[number]&range=[number]&status=[all|all campaigns|drafts|scheduled|inprogress|sent|stopped|canceled|tobereviewed|reviewed|paused|intesting]

    Sample Response

    Copied{
"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": "marketingautomation.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": "marketingautomation.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": "marketingautomation.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": "marketingautomation.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": "marketingautomation.zoho.com/EmailDisplayAction.do?&campaignId=303000023453072"
}
],
"code": "0",
"uri": "/api/v1/recentcampaigns",
"version": "1"
}