Get Segment Subscribers

Get Segment Subscribers

Users can get the segment subscribers using our API.

Request URL

You've an option of using either the XML (or) JSON format at the time of request.

XML/ JSON

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

Request Type: Get/ Post

List of Parameters

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

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/getsegmentcontacts?authtoken=[API Authentication Token]&scope=CampaignsAPI&cvid=[cvid]&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/getsegmentcontacts" version="1">

<status>success</status>

<code>0</code>

<range>20</range>

<cvid>303000014567003</cvid>

<fromindex>1</fromindex>

<segment_contacts>

<contact>

<fl val="contact_email">user512@thandora.com</fl>

<fl val="firstname"/>

<fl val="lastname"/>

<fl val="companyname"/>

<fl val="added_time">22 Apr 2011, 04:37 PM</fl>

<fl val="phone"/>

</contact>

<contact>

<fl val="contact_email">user212@thandora.com</fl>

<fl val="firstname"/>

<fl val="lastname"/>

<fl val="companyname"/>

<fl val="added_time">22 Apr 2011, 04:37 PM</fl>

<fl val="phone"/>

</contact>

<contact>

<fl val="contact_email">user612@thandora.com</fl>

<fl val="firstname"/>

<fl val="lastname"/>

<fl val="companyname"/>

<fl val="added_time">22 Apr 2011, 04:37 PM</fl>

<fl val="phone"/>

</contact>

<contact>

<fl val="contact_email">user118@thandora.com</fl>

<fl val="firstname">changefname users</fl>

<fl val="lastname">users</fl>

<fl val="companyname"/>

<fl val="added_time">16 Apr 2011, 09:00 PM</fl>

<fl val="phone"/>

</contact>

</segment_contacts>

</response>

JSON Format:

{"requestdetails":{"range":20,"cvid":303000023471055,"fromindex":1},"status":"success","list_of_details":[{"phone":"","contact_email":"hhh@dsd.com","lastname":"","firstname":"","companyname":""}],"code":"0","uri":"/api/getsegmentcontacts","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.
2604 There are no subscribers in this segments.

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