PUT - Disable Email Forwarding

Purpose

This API is used to disable email forwarding for a user account. This can be done by the admin for a user or by the user for themselves.

OAuth Scope

Use the scope

Using admin authentication:

ZohoMail.organization.accounts.ALL (or) ZohoMail.organization.accounts.UPDATE

Using user authentication:

ZohoMail.accounts.ALL (or) ZohoMail.accounts.UPDATE

to generate the Authtoken.

ALL - Grants full access to accounts.

UPDATE - Grants access to update account information.

Request URL

Method: PUT

Using admin authentication:

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

Using user authentication:

https://mail.zoho.com/api/accounts/{accountId}

Path Parameters

  • zoid long
    • This parameter denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be retrieved from the Get Organization Details API.
    • This parameter is mandatory while using admin authentication.
  • accountId* long
    • This parameter is used to identify the account whose details are retrieved.
    • This parameter can be retrieved from the Get User Account Details API.

 

Request Body ( JSON Object)

  • zuid long
    • This denotes the unique Zoho User Identifier for the user.
    • This parameter can be fetched from Get All Org Users Details API.
    • This parameter is mandatory while using admin authentication.
  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as disableMailForward.
  • mailForward* JSON array of objects
    • This parameter is array of single or multiple objects which contains the following fileld
      • mailForwardTo* string
        • This parameter specifies the email address to which the incoming emails should be forwarded to. 

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request (Using Admin Authentication)

Copiedcurl "https://mail.zoho.com/api/organization/12345678/accounts/2560636000000008002" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
-d '{
  "zuid": 11111111,
  "mode": "disableMailForward",
  "mailForward": [
     {
        "mailForwardTo": "paula@zylker.com"
     }
  ]
}'

Sample Request (Using User Authentication)

Copiedcurl "https://mail.zoho.com/api/accounts/2560636000000008002" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
-d '{
  "mode": "disableMailForward",
  "mailForward": [
    {
      "mailForwardTo": "paula@zylker.com"
    }
  ]
}'

Sample Response

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