PUT - Add Email Alias

Purpose

The API is used to add an email alias for a user in the organization. 

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Grants full access to accounts.

UPDATE - Grants update access to accounts.

Request URL 

Method: PUT

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

Path Parameters

  • zoid* long
    • This parameter denotes the unique Zoho Organization Identifier for the organization. 
    • This value can be retrieved using the GET organization details API.
  • zuid long
    • This parameter denotes the unique identifier for each user in an organization. 
    • This value can be retrieved using the GET all org user details API.

Request Body (JSON Object)

  • zuid* long
    • This parameter denotes the unique identifier for each user in an organization. 
    • This value can be retrieved using the GET all org user details API.
  • mode* string
    •  This parameter represents the type of operation that is to be performed.
    •  Provide the value as addEmailAlias.
  • emailAlias*  JSON array of strings
    •  This parameter needs to be passed as an array of single or multiple email addresses that needs to be added as alias to the  user.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

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

Sample Response

Copied{
  "status": {
    "code": 200,
    "description": "success"
  },
  "data": [
    {
      "paula@zylker.com": "8923900011000011001"
    }
  ]
}