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
List of Parameters -- Version 1.1
Parameter | Data Type | Description |
listkey* | String | List Key to send a subscription mail to contacts. |
resfmt | String | XML (or) JSON |
newlistname* | String | Give list name. |
signupform* | String | public/private |
* - Mandatory Parameters
Possible error cases
Error code | Description |
903 | Mandatory fields are missing. |
2102 | Listkey is empty or invalid. |
2206 | List 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"
}