Total Contacts
You don’t have to research on how effective a list has been or how much reach does a particular list measure. Find out using our API Authentication Token to find out the number of contacts in a list.
Request Type:
- Get
Scope required
ZohoCampaigns.contact.READ
Other alternative scopes
- ZohoCampaigns.contact.ALL (CREATE + UPDATE + DELETE + READ)
Header:
Authorization: Zoho-oauthtoken <access_token>
Request URL:
https://campaigns.zoho.com/api/v1.1/listsubscriberscount
List of Parameters --Version 1.1
Parameter | Data Type | Description |
listkey* | String | List Key to send a subscription mail to contacts |
resfmt | String | XML (or) JSON |
status | String | [active|unsub|bounce|spam] |
* - Mandatory Parameter
Possible error cases
Error code | Description |
2202 | Listkey is empty or invalid. |
2707 | Mailing list is deleted from your account. |
2704 | Insufficient privilege to access other users' mailing list. |
2701 | Insufficient privilege to access your mailing list. |
2001 | Please enter correct XML(or)JSON format. |
If your error code is not listed above, click here.
Sample XML Request
Copiedhttps://campaigns.zoho.com/api/v1.1/listsubscriberscount?resfmt=XML&listkey=[listkey]&status=[active|unsub|bounce|spam]
Sample Response
Copied<response uri="/api/v1.1/listsubscriberscount" version="1.1">
<code>0</code>
<status>success</status>
<no_of_contacts>2</no_of_contacts>
</response>
Sample JSON Request
Copiedhttps://campaigns.zoho.com/api/v1.1/listsubscriberscount?resfmt=[JSON]&listkey=[listkey]&status=[active|unsub|bounce|spam]
Sample Response
Copied{
"status": "success",
"code": "0",
"uri": "/api/v1.1/listsubscriberscount",
"no_of_contacts": 2,
"version": "1.1"
}