Get Mailing Lists
Using this API, you can fetch the mailing lists and it'll be notified automatically.
Scope required
- ZohoMarketingAutomation.lead.READ
Other alternative scopes
- ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)
Header:
Authorization: Zoho-oauthtoken <access_token>
Content-Type: application/x-www-form-urlencoded
Request type:
- POST
Request URL
https://marketingautomation.zoho.com/api/v1/getmailinglists
API Limit
- Duration: 5 mins
- Number of Calls: 500
- Lock Period: 30 mins
You can send 500 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.
List of Parameters
Parameter | Data type | Description |
resfmt | String | JSON |
sort | String | asc/desc |
fromindex | Number | Values in number |
range | Number | Values in number |
* - Mandatory parameters
Possible error cases
Error code | Description |
1004 | Unable to find the resource you're looking for. Please recheck the documentation and try again. |
2706 | Insufficient privilege to access the list. |
2402 | Error in displaying details. Please try after sometime. |
2401 | No mailing list has been created. Please create a list. |
If your error code is not listed above, click here.
Sample request
Copiedhttps://marketingautomation.zoho.com/api/v1/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",
"noofleads": "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",
"noofleads": "1393",
"listname": "111",
"zuid": "8846468",
"noofunsubcnt": "2",
"is_public": "true",
"noofbouncecnt": "0",
"owner": "john.doe.b",
"listkey": "3c20ad524dfa4af85c20ad3564a05789"
}
],
"code": "0",
"uri": "/api/v1/getmailinglists",
"version": "1"
}