Add Contacts in Existing List

Did you know that you can also add leads not only to a new list but also existing lists using API? Well, using this API you can add leads in existing list.

Request Type:

  • POST

Scope required

  • ZohoCampaigns.contact.CREATE

Other alternative scopes

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

Header:

Authorization: Zoho-oauthtoken <access_token>

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

Request URL

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

API Limit

  • Duration: 1 minute
  • Number of Calls: 2,000
  • Lock Period: 10 mins

You can send 2,000 API calls per minute. If you hit this limit, you can't use this API for the next 10 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.

List of Parameters -- Version 1.1

ParameterData TypeDescription
listkey*StringList Key to send a subscription mail to contacts in the list.
resfmtStringXML (or) JSON
emailids*StringProvide maximum of ten (10) EMAILID's comma (,) separately.

* - Mandatory Parameters

Possible Error Cases

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

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

Sample XML Request

Copiedhttps://campaigns.zoho.com/api/v1.1/addlistsubscribersinbulk?resfmt=XML&listkey=listkey&emailids=[email addresses]

Sample Response

Copied<?xml version="1.1" encoding="UTF-8" standalone="no"?>
<response uri="/api/v1.1/addlistsubscribersinbulk" version="1.1">
	<code>0</code>
	<status>success</status>
	<listkey>f70c4878c4a471692bb9a99a2d5ed3a7</listkey>
	<listname>1issst11deed88</listname>
</response>

Sample JSON Request

Copiedhttps://campaigns.zoho.com/api/v1.1/addlistsubscribersinbulk?listkey=listkey&resfmt=[JSON]&emailids=[email addresses]

Sample Response

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