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

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