Update Group Member Role
Purpose
The API is used to update the role of the group member.
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 group details.
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 changeMemberRole.
- 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
- 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
* - 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": "changeMemberRole",
"mailGroupMemberList": [
{
"memberEmailId": "rebecca@zylker.com",
"role": "moderator"
}
]
}'Sample Request Body
Copied{
"mode": "changeMemberRole",
"mailGroupMemberList": [
{
"memberEmailId": "rebecca@zylker.com",
"role": "moderator"
}
]
}Sample Response
Copied{
"status": {
"code": 200,
"description": "success"
}
}