Get Campaign Recipients' Data

Using this API, you can get the campaign recipients' data which includes sent time, sent date and lead id.

Scope required

  • ZohoMarketingAutomation.campaign.READ

Other alternative scopes

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

Header:

Authorization: Zoho-oauthtoken <access_token>

Request type:

  • POST

Request URL

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

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

ParameterData type         Description                                                                      
resfmtStringJSON
campaignkey*String[campaignkey]
action*String
  • sentleads
  • openedleads
  • optoutleads
  • spamleads
  • unopenedleads
  • clickedleads
  • senthardbounce
  • sentsoftbounce
  • unsentleads

* - Mandatory parameters

Possible error cases

Error codeDescription
6601AB campaign cannot be sent to less than 4 recipients.
6607Insufficient privileges to perform this action. Please lead the org admin.
6303There are no leads in the selected mailing list.
6002Invalid campaign key (or) campaign is not yet sent.

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

Sample Request

Copiedhttps://marketingautomation.zoho.com/api/v1/getcampaignrecipientsdata?resfmt=[JSON]&campaignkey=[campaignkey]&action=[sentleads|openedleads|optoutleads|spamleads|unopenedleads|clickedleads|senthardbounce| sentsoftbounce|unsentleads]

Sample Response

Copied{
  "requestdetails": {
    "range": 20,
    "action": "sent",
    "fromindex": 1
  },
  "status": "success",
  "list_of_details": [
    {
      "phone": "null",
      "timezone": "null",
      "leadstatus": "active",
      "leademailaddress": "john.doe@xyz.com",
      "sent_time": "1375456161000",
      "lastname": "",
      "sentdate": "02 Aug 2013, 12:39 PM",
      "firstname": "meganath.v",
      "leadid": "303000014269257",
      "companyname": "null"
    }
  ],
  "code": "0",
  "uri": "/api/v1/getcampaignrecipientsdata",
  "version": "1"
}