Update Member Status


This API is used to change the status of the members in 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 - Update groups.

Request URL

Method : PUT


Path Parameters

  • zoid* long
    • This parameter denotes the unique Zoho Organization Identifier for the organization.
    • This parameter can be retrieved from the Organization Details API.
  • zgid* long
    • This parameter is used to identify the group in which the data has to be updated.
    • This parameter can be retrieved from the All Groups Details API.

Request Body (JSON Object)

  • mode* string
    • This parameter represents the type of operation that is to be performed.
    • Provide the value as updateMailGroupMember.
  • mailGroupMemberList* JSON array of JSON object

    This array should contain objects detailing the members of the group whose status needs to be updated. Each object should have the following parameters:

    • memberEmailId* string
      • Represents the email address of the group member whose member status has to be changed.
    • status* string
      • This parameter specifies the status to which the member's status should be changed.
      • The possible values can be:
        • active
        • deactive


* - 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": "updateMemberStatus",
    "mailGroupMemberList": [
            "memberEmailId": "rebecca@zylker.com",
            "status": "active"

Sample Request Body

    "mode": "updateMemberStatus",
    "mailGroupMemberList": [
            "memberEmailId": "rebecca@zylker.com",
            "status": "active"

Sample Response

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