PUT - Update Organization Spam Processing Type

 Purpose

This API updates the Organization's spam processing type using which you can disable or set the level of spam filter needed for the organization. The spam configuration would be set as per the value provided in the request JSON Object. 

OAuth Scope

Use the scope

Zohomail.partner.organization.ALL (or) Zohomail.partner.organization.UPDATE

to generate the Authtoken.

ALL - Full access to the organization.

UPDATE - Update the organization's details.

Request URL

Method: PUT

https://mail.zoho.com/api/organization/{zoid}

Path Parameters

  • zoid* long
    • This denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be fetched from Organization Details API.

Request Body (JSON Object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as updateSpamProcessType
  • spamVO* JSON Object
    • spamProcessType string
      • This parameter specifies the details of the spam process to be updated.
      • The value passed in this parameter can disable or set the spam filter for the organization.
      • The possible value can be
        • Off
        • complete
        • content
        • sender
        • sender_header

 

* - Mandatory parameter.

Response Codes

Refer here for the response codes and their meaning.

Sample Request Body

Copied{
   "mode": "updateSpamProcessType",
   "spamVO": {
      "spamProcessType": "sender_header"
   }
}

The above request sets the organization's spam filtering level to 'Sender Header'.

Sample Response

Copied{
    "status": {
        "code": 200,
        "description": "success"
    }
}