Get Segment Details
Users can get the segment details by using our API.
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/getsegmentdetails
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 |
| 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. OR Please enter correct data type format. |
If your error code is not listed above, clickhere.
Sample Request
Copiedhttps://marketingautomation.zoho.com/api/v1/getsegmentdetails?resfmt=JSON&cvid=[cvid]&listkey=[listkey]Sample Response
Copied{
"status": "success",
"segments_details": "{column_value=[tes], exact_column_name=[], logical_operator_count=0, pattern=, column_name=[lead Email], logical_operator=[], column_comparator=[contains]}",
"code": "0",
"uri": "/api/v1/getsegmentdetails",
"version": "1"
}