Get Segment Details

Get Segment Details

Users can get the segment details by using our API Authentication Token.

Request URL

XML/ JSON

https://campaigns.zoho.com/api/getsegmentdetails

Request Type: Get

List of Parameters

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

listkey*

String

List Key to send a subscription mail to contacts.

version

String

This will fetch responses based on the current API version.

resfmt

String

XML (or) JSON

cvid*

Number

You will get cvid from getmailinglists.

* - Mandatory Parameters

Sample Request:

XML/ JSON:

https://campaigns.zoho.com/api/getsegmentdetails?authtoken=[API Authentication Token]&scope=CampaignsAPI&cvid=[cvid]&listkey=[listkey]&resfmt=[XML/JSON

Sample Response:

Our API response will let you know of the following be it in the XML or JSON format.

XML Format:

<response uri="/api/getsegmentdetails" version="1">

<status>success</status>

<code>0</code>

<segment_details>

<criteria>

<fl val="no">0</fl>

<fl val="operator"></fl>

<fl val="column_name">Contact Email</fl>

<fl val="comparator">contains</fl>

<fl val="column_value">tes</fl>

</criteria>

</segment_details>

</response>

JSON format:

{"status":"success","segments_details":"{column_value=[tes], exact_column_name=[], logical_operator_count=0, pattern=, column_name=[Contact Email], logical_operator=[], column_comparator=[contains]}","code":"0","uri":"/api/getsegmentdetails","version":"1"}

Possible Error Cases

Error code Description
903Mandatory 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, click here.

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocampaigns.com