Get Segment Contacts

Using this API, you can get the segment contacts along with their relevant details like first name, last name, time when they were added, company and their phone number.

Request Type

  • Get/ Post

Scope required

  • ZohoCampaigns.contact.READ

    Other alternative scopes

    • ZohoCampaigns.contact.ALL (CREATE + UPDATE + DELETE + READ)

    Header:

    Authorization: Zoho-oauthtoken <access_token>

    Request URL

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

    List of Parameters --Version 1.1

    Parameter

    Data Type

    Description

    resfmt

    String

    XML (or) JSON

    cvid*

    Number

    You will get cvid from getmailinglists.

    * - Mandatory Parameters

    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 contacts in this segments.

    If your error code is not listed above, click here.

    Sample XML Request

    
    				https://campaigns.zoho.com/api/v1.1/getsegmentcontacts?resfmt=XML&cvid=[cvid]			

    Sample Response

    
    				<response uri="/api/v1.1/getsegmentcontacts" version="1.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>			

    Sample JSON Request

    
    				https://campaigns.zoho.com/api/v1.1/getsegmentcontacts?resfmt=JSON&cvid=[cvid]			

    Sample Response

    
    				{
      "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/v1.1/getsegmentcontacts",
      "version": "1.1"
    }