Update Advanced Admin Settings for the Group

Purpose

This API is used to change the advanced settings for the 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 advanced settings for the group.

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 updateMailGroupAdvOptions.
  • accessType* string
    • This parameter represents the access type of the group.
    • The possible value for this parameter can be
      • Public
      • Organization
      • Group
      • Moderated
  • groupAdminSettings* JSON object

    This object should contain the following parameters to detail the settings of the group to be updated:

    • holdOrBounce string
      • Specifies whether the email should be held or rejected.
      • The possible value can be
        • hold
        • reject
    • adminNotify boolean
      • Specifies whether the administrator should be notified or not.
      • The possible value can be
        • true
        • false 
      • Default Value: false(if not specified).
    • authorNotify boolean
      • Specifies whether the sender of the email should be notified or not.
      • The possible value can be
        • true
        • false 
      • Default Value: false(if not specified).
    • isNotToCc boolean
      • Specifies the email delivery behaviour when the group email address is not specified in the "To" or "Cc" fields of the outgoing message.
      • The possible values can be:
        • true: If the group email address is not found in either the "To" or "Cc" fields, the email will not be delivered.
        • false: The presence or absence of the group email address in the "To" or "Cc" fields will not impact email delivery.
      • Default Value: false(if not specified).
    • mailboxSendRights boolean
      • Specifies whether the members of the email group should be able to send emails using the group.
      • The possible values can be:
        • true 
        • false 
      • Default Value: false(if not specified).
    • postApprovedNotify boolean
      • Specifies whether the post-approval should be notified or not.  
      • The possible values can be:
        • true
        • false
      • Default Value: false(if not specified).
    • spamMarkPermission boolean
      • Specifies the ability to mark an email or message as spam.
      • The possible values can be:
        • true - Grants permission to mark the message as spam.
        • false - Denies permission to mark the message as spam.
      • Default Value: false(if not specified).
    • suppressMailOnMemAdd boolean
      • Specifies whether email should be sent to members on member addition or not. 
      • The possible values can be:
        • true 
        • false 
      • Default Value: false(if not specified).

* - 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": "updateMailGroupAdvOptions",
    "accessType": "Organization",
    "groupAdminSettings": {
        "holdOrBounce": "hold",
        "adminNotify": true,
        "authorNotify": true,
        "isNotToCc": true,
        "mailboxSendRights": false,
        "postApprovedNotify": false,
        "spamMarkPermission": false,
        "suppressMailOnMemAdd": true
    }
}'

Sample Request Body

Copied{
    "mode": "updateMailGroupAdvOptions",
    "accessType": "Organization",
    "groupAdminSettings": {
        "holdOrBounce": "hold",
        "adminNotify": true,
        "authorNotify": true,
        "isNotToCc": true,
        "mailboxSendRights": false,
        "postApprovedNotify": false,
        "spamMarkPermission": false,
        "suppressMailOnMemAdd": true
    }
}

Sample Response

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