Get Mailing Lists

Using this API, you can fetch the mailing lists and it'll be notified automatically.

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/getmailinglists

    List of Parameters --Version 1.1

    Parameter

    Data Type

    Description

    resfmt

    String

    XML (or) JSON

    sort

    String

    asc/desc

    fromindex

    Number

    values are in number.

    range

    Number

    values are in number.

    * - Mandatory Parameters

    Possible error cases

    Error code Description
    1004Unable to find the resource you're looking for. Please recheck the documentation and try again.
    2706Insufficient privilege to access the list.
    2402 Error in displaying details. Please try after sometime.
    2401No mailing list has been created. Please create a list.

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

    Sample XML Request

    Copiedhttps://campaigns.zoho.com/api/v1.1/getmailinglists?resfmt=XML&sort=[asc/desc]&fromindex=[number]&range=[number]
    

    Sample Response

    Copied<response uri="/api/v1.1/getmailinglists" version="1.1">
    	<status>success</status>
    	<code>0</code>
    	<sort>Ascending Order</sort>
    	<range>2</range>
    	<fromindex>1</fromindex>
    	<list_of_details>
    		<list>
    			<fl val="created_date">1316108278000</fl>
    			<fl val="listunino">6361736964559881</fl>
    			<fl val="noofbouncecnt">0</fl>
    			<fl val="segments"/>
    			<fl val="lockstatus">unlocked</fl>
    			<fl val="is_public">false</fl>
    			<fl val="zuid">229788</fl>
    			<fl val="noofunsubcnt">0</fl>
    			<fl val="owner">Naveen</fl>
    			<fl val="listkey">3c20ad524dfa4af86216a5be13e238ed</fl>
    			<fl val="listname">1</fl>
    			<fl val="noofcontacts">57</fl>
    		</list>
    		<list>
    			<fl val="created_date">1358908439000</fl>
    			<fl val="listunino">6361736976335832</fl>
    			<fl val="noofbouncecnt">0</fl>
    			<fl val="segments"/>
    			<fl val="lockstatus">unlocked</fl>
    			<fl val="is_public">true</fl>
    			<fl val="zuid">8846468</fl>
    			<fl val="noofunsubcnt">2</fl>
    			<fl val="owner">john.doe</fl>
    			<fl val="listkey">3c20ad524dfa4af85c20ad3564a05789</fl>
    			<fl val="listname">111</fl>
    			<fl val="noofcontacts">1393</fl>
    		</list>
    	</list_of_details>
    </response>

    Sample JSON Request

    Copiedhttps://campaigns.zoho.com/api/v1.1/getmailinglists?resfmt=JSON&sort=[asc/desc]&fromindex=[number]&range=[number]
    
    

    Sample Response

    Copied{
      "requestdetails": {
        "sort": "Ascending Order",
        "range": 2,
        "fromindex": 1
      },
      "status": "success",
      "list_of_details": [
        {
          "created_date": "1316108278000",
          "segments": "{}",
          "lockstatus": "unlocked",
          "listunino": "6361736964559881",
          "date": "15 Sep 2011, 03:07 PM",
          "noofcontacts": "57",
          "listname": "1",
          "zuid": "229788",
          "noofunsubcnt": "0",
          "is_public": "false",
          "noofbouncecnt": "0",
          "owner": "Naveen",
          "listkey": "3c20ad524dfa4af86216a5be13e238ed"
        },
        {
          "created_date": "1358908439000",
          "segments": "{}",
          "lockstatus": "unlocked",
          "listunino": "6361736976335832",
          "date": "23 Jan 2013, 12:03 AM",
          "noofcontacts": "1393",
          "listname": "111",
          "zuid": "8846468",
          "noofunsubcnt": "2",
          "is_public": "true",
          "noofbouncecnt": "0",
          "owner": "john.doe.b",
          "listkey": "3c20ad524dfa4af85c20ad3564a05789"
        }
      ],
      "code": "0",
      "uri": "/api/v1.1/getmailinglists",
      "version": "1.1"
    }