Update Group Member Settings

Purpose

This API is used to update the details of members of 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

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

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 updateGroupMemberDetails.
  • mailGroupMemberList* JSON array of JSON object

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

    • memberEmailId* string
      • memberEmailId represents the email address of the group member whose member details have to be updated.
    • role string
      • This parameter mentions the role to which the member role should be changed.
      • The possible values can be
        • member
        • moderator
      • The default value is the member.
    • status string
      • This parameter mentions the status to which the member status should be changed.
      • The possible values can be
        • active
        • deactive
    • ackStatus boolean
      • This parameter mentions whether acknowledgement should be sent to the user or not.
      • The possible values can be
        • true
        • false
    • postApproval string
      • This parameter mentions whether emails from the user should be delivered to the user, held for moderation, or rejected and bounced back.
      • The possible values can be
        • accept
        • hold
        • reject

 

* - 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": "updateGroupMemberDetails",
    "mailGroupMemberList": [
        {
            "ackStatus": false,
            "memberEmailId": "domainadmin@zylker.com",
            "postApproval": "accept",
            "role": "moderator",
            "status": "deactive"
        }
    ]
}'

Sample Request Body

Copied{
    "mode": "updateGroupMemberDetails",
    "mailGroupMemberList": [
        {
            "ackStatus": false,
            "memberEmailId": "domainadmin@zylker.com",
            "postApproval": "accept",
            "role": "moderator",
            "status": "deactive"
        }
    ]
}

Sample Response

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