Total Leads
You don’t have to research on how effective a list has been or how much reach does a particular list measure. Using this API, you can easily find out the number of leads in a list.
Scope required
- ZohoMarketingAutomation.lead.READ
Other alternative scopes
- ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)
Header:
Authorization: Zoho-oauthtoken <access_token>
Request type:
- GET
Request URL
https://marketingautomation.zoho.com/api/v1/leadscount
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
| Parameter | Data type | Description |
| listkey* | String | List Key to send a subscription mail to leads |
| resfmt | String | JSON |
| status | String | To be separated by'|'
|
* - 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 JSON format. |
If your error code is not listed above, click here
Sample request
Copiedhttps://marketingautomation.zoho.com/api/v1/leadscount?resfmt=[JSON]&listkey=[listkey]&status=[active|unsub|bounce|spam]Sample Response
Copied{
"status": "success",
"code": "0",
"uri": "/api/v1/leadscount",
"no_of_leads": 2,
"version": "1"
}