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
List of parameters
Parameter | Data type | Description |
resfmt | String | JSON |
campaignkey* | String | [campaignkey] |
action* | String |
|
* - Mandatory parameters
Possible error cases
Error code | Description |
6601 | AB campaign cannot be sent to less than 4 recipients. |
6607 | Insufficient privileges to perform this action. Please lead the org admin. |
6303 | There are no leads in the selected mailing list. |
6002 | Invalid 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"
}