Add Email Aliases to a Group

Purpose

This API is used to add email aliases for a group.

OAuth Scope

Use the scope

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

to generate the Authtoken.

ALL - Full access to groups.

UPDATE - Add alias list to a group

Request URL

Method: PUT

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

Request Body (JSON Object)

  • aliasList* JSON array of string
    • This parameter needs to be passed as an array of single or multiple email addresses that are intended to be added as an alias.
  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as addGroupAlias.

 

* - Mandatory parameter

Response Codes

Refer here for the response codes and their meaning.

Sample Request

Copiedcurl "https://mail.zoho.com/api/organization/99***293/groups/25606***" \
-X PUT \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization:Zoho-oauthtoken ***" \
-d '{
  "mode": "addGroupAlias",
  "aliasList": [
    "rebecca@zylker.com"
  ]
}'

Sample Request Body

Copied{
  "mode": "addGroupAlias",
  "aliasList": [
    "rebecca@zylker.com"
  ]
}

Sample Response

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