Add New List and Leads

Using this API, you can add new list and leads in the list without having to do this manually in the product UI.

Scope required

  • ZohoMarketingAutomation.lead.CREATE

Other alternative scopes

  • ZohoMarketingAutomation.lead.CREATE-UPDATE (CREATE + UPDATE)
  • ZohoMarketingAutomation.lead.WRITE (CREATE + UPDATE + DELETE)
  • ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)

Request Type

  • POST

Header:

Authorization: Zoho-oauthtoken <access_token>

Content-Type: application/x-www-form-urlencoded

Request URL

https://marketingautomation.zoho.com/api/v1/addlistandleads

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

ParameterData TypeDescription
resfmtStringJSON
emailids*StringProvide maximum of ten (10) EMAILID's comma (,) separately.
listname*StringProvide your list name.
signupform*Stringpublic/private.
mode*Stringnewlist
listdescriptionStringProvide a description for your list.
topic_idStringTopic ID to subscribe topics to leads in the mailing list. You can pass comma separated topic IDs as well. 

* - Mandatory parameters

Possible error cases

Error codeDescription
903Mandatory fields are missing.
2205Duplicate list name is found.
2206List has been deleted.
2302You cannot add leads as you've reached the maximum limit.

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

Sample Request

Copiedhttps://marketingautomation.zoho.com/api/v1/addlistandleads?resfmt=JSON&listname=[give ur list name]&signupform=[public/private]&mode=newlist&listdescription=[give your list description]&emailids=[email addresses]

Sample Response

Copied{
"status": "success",
"listkey": "f70c4878c4a471691e3931dd52bedc79",
"code": "0",
"url": "/api/v1/addlistandleads",
"listname": "1issst1oo1deed88",
"version": "1"
}