Update List

Updating a list can be to rename a list or to associate a signup form to the list. Using this API, you can make changes in mailing lists.

Request Type

  • POST

Scope required

  • ZohoCampaigns.contact.UPDATE

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

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 -- Version 1.1

ParameterData TypeDescription
listkey*StringList Key to send a subscription mail to contacts.
resfmtStringXML (or) JSON
newlistname*StringGive list name.
signupform*Stringpublic/private

* - Mandatory Parameters

Possible error cases

Error codeDescription
903Mandatory fields are missing.
2102Listkey is empty or invalid. 
2206List has been deleted.

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

Sample XML Request

Copiedhttps://campaigns.zoho.com/api/v1.1/updatelistdetails?resfmt=XML&listkey=[listkey]&newlistname=[give list name]&signupform=[public/private]

Sample Response

Copied<response uri="/api/v1.1/updatelistdetails" version="1.1">
	<code>0</code>
	<status>success</status>
	<message>List updated successfully.</message>
</response>

Sample JSON Request

Copiedhttps://campaigns.zoho.com/api/v1.1/updatelistdetails?resfmt=JSON&listkey=[listkey]&newlistname=[give list name]&signupform=[public/private]

Sample Response

Copied{
  "message": "List updated successfully.",
  "status": "success",
  "code": "0",
  "uri": "/api/v1.1/updatelistdetails",
  "version": "1.1"
}