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

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


				https://marketingautomation.zoho.com/api/v1/getsegmentleads?resfmt=JSON&cvid=[cvid]			

Sample response


				{
"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"
}