Get Campaign Recipients Data

Get Campaign Recipients Data

Users can get the campaigns' recipients data using our API authentication token.

Request URL

XML/ JSON

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

Request Type: Post

List of 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

campaignkey*

String

[campaignkey]

action*

String

[sentcontacts|openedcontacts|optoutcontacts|spamcontacts

|unopenedcontacts|clickedcontacts|senthardbounce| sentsoftbounce|unsentcontacts]

* - Mandatory Parameters

Sample Request:

XML/ JSON

https://campaigns.zoho.com/api/getcampaignrecipientsdata?authtoken=[API Authentication Token]&scope=CampaignsAPI&campaignkey=[campaignkey]&action=[sentcontacts|openedcontacts|optoutcontacts|spamcontacts|unopenedcontacts|clickedcontacts|senthardbounce| sentsoftbounce|unsentcontacts]&resfmt=[XML|JSON]

Sample Response:

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

XML Format:

<response uri="/api/getcampaignrecipientsdata" version="1">

<status>success</status>

<code>0</code>

<range>20</range>

<action>sentcontacts</action>

<fromindex>1</fromindex>

<campaign_details>

<fl val="email_status">Sent</fl>

<fl val="zuid">4179027</fl>

<fl val="campaign_name">Zoho Survey 7</fl>

<fl val="email_subject">Zoho Survey 7</fl>

</campaign_details>

<contacts>

<contact>

<fl val="added_time">02 Aug 2013, 12:39 PM</fl>

<fl val="first_name">meganath.v</fl>

<fl val="last_name"/>

<fl val="company_name"/>

<fl val="phone"/>

<fl val="contact_email">john.doe@xyz.com</fl>

</contact>

</contacts>

</response>

JSON format:

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

Possible error cases

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

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

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocampaigns.com