Get Segment Leads
Using this API, you can get the segment leads along with their relevant details like first name, last name, time when they were added, company and their phone number.
Scope required
- ZohoMarketingAutomation.lead.READ
Other alternative scopes
- ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)
Header:
Authorization: Zoho-oauthtoken <access_token>
Request type
- GET/POST
Request URL
https://marketingautomation.zoho.com/api/v1/getsegmentleads
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 |
| resfmt | String | JSON |
| cvid* | Number | You will get cvid from getmailinglists. |
* - Mandatory parameters
Possible error cases
| Error code | Description |
| 903 | Mandatory fields are missing. |
| 2202 | Listkey is empty or invalid. |
| 2603 | Error in getting segments details. Please try after sometime. |
| 2604 | There are no leads in this segments. |
If your error code is not listed above, click here.
Sample request
Copiedhttps://marketingautomation.zoho.com/api/v1/getsegmentleads?resfmt=JSON&cvid=[cvid]Sample Response
Copied{
"requestdetails": {
"range": 20,
"cvid": 303000023471055,
"fromindex": 1
},
"status": "success",
"list_of_details": [
{
"phone": "",
"lead_email": "hhh@dsd.com",
"lastname": "",
"firstname": "",
"companyname": ""
}
],
"code": "0",
"uri": "/api/v1/getsegmentleads",
"version": "1"
}