DELETE - Remove Organization Spam Listing Info
Purpose
The API removes the Organization's Spam Listing Info. The type of listing can be Organization Whitelist/ Blacklist Domains or Email Addresses.
OAuth Scope
Use the scope ZohoMail.organization.spam.ALL (or) ZohoMail.organization.spam.DELETE to generate the Authtoken.
ALL - Full access to all spam details
DELETE - Removes spam details
Request URL
https://mail.zoho.com/api/organization/<zoid>/antispam/data
Path Parameters
- zoidlong, mandatory
- The zoid of the organization that can be fetched using the GET Organization details API.
Request Body (JSON Object)
- spamCategorystring, mandatory
- Use this parameter to specify the type of Spam Listing that needs to be removed.
- Supported values are:
- whiteListEmail
- spamEmail
- rejectEmail
- quarantineEmail
- trustedEmail
- whiteListDomain
- spamDomain
- rejectDomain
- quarantineDomain
- trustedDomain
- whiteListIP
- spamIP
- rejectIP
- quarantineIP
- spamTLD
- rejectTLD
- quarantineTLD
- recipientSpamEmail
- recipientRejectEmail
- recipientQuarantineEmail
- ValueArray of strings, mandatory
- The values such as emails ids, domains, and IP addresses need to be given as value for this parameter.
- Supported format: ["Value 1", "Value 2", ......, "Value n"]
Response Codes
Refer here for the response codes and their meaning.
Sample Request
Copiedhttps://mail.zoho.com/api/organization/987654321/antispam/dataRequest Body (JSON Object)
Copied{
"spamCategory":"whiteListEmail",
"whiteListEmail":[
"mysupply@mysupplydomain.com"
]
}The above request body removes the email ids specified in the Value array from the Whitelist Emails List of the organization.
Sample Response
Copied{
"status": {
"code": 200,
"description": "success"
}
}