Move to Do-Not-Mail
You can move the subscriber to do-not-mail registry if you do not want to send emails further to that user or if they unsubscribe from the organization. Using this API, you can move/add leads into "Do-Not-Mail" registry.
Scope required
ZohoMarketingAutomation.lead.UPDATE
Other alternative scopes
ZohoMarketingAutomation.lead.CREATE-UPDATE (CREATE + UPDATE)
ZohoMarketingAutomation.lead.WRITE (CREATE + UPDATE + DELETE)
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/json/leaddonotmail
List of parameters
Parameter | Data type | Description |
resfmt | String | JSON |
leadinfo* | String | Provide email id to be moved to Do-Not-Mail registry. |
* - Mandatory parameters
Possible error cases
Error code | Description |
0 | User already in Do-Not-Mail. |
2004 | Invalid email address pattern. |
2104 | Error in Do-not-mail. Please retry after sometime. |
If your error code is not listed above, click here.
Sample request
Copiedhttps://marketingautomation.zoho.com/api/v1/json/leaddonotmail?resfmt=JSON&leadinfo=%7BLead+Email%3Axxx%40zohocorp.com%7D
Sample Response
Copied{
"code": "0",
"message": "User successfully moved to Do-Not-Mail.",
"version": "1",
"uri": "/api/v1/json/leaddonotmail",
"status": "success"
}