{ "components": { "securitySchemes": { "iam-oauth2-schema": { "flows": { "authorizationCode": { "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "scopes": { "ZohoMail.organization.groups.ALL": "Full access to Group management", "ZohoMail.organization.groups.CREATE": "Write access to Group management", "ZohoMail.organization.groups.DELETE": "delete access to Groups", "ZohoMail.organization.groups.READ": "Read access to groups", "ZohoMail.organization.groups.UPDATE": "update access to groups" }, "tokenUrl": "https://accounts.zoho.com/oauth/v2/token" } }, "type": "oauth2" } } }, "info": { "title": "Zohomail cli", "version": "1.0" }, "openapi": "3.0.1", "paths": { "/api/organization/{addGroupAliasZoid}/groups/{zgid}": { "description": "To add email aliases for a group.", "put": { "operationId": "addGroupAlias", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addGroupAliasZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aliasList": [ "rebecca@zylker.com" ], "mode": "addGroupAlias" }, "schema": { "properties": { "aliasList": { "description": "This field needs to be passed as an array of single or multiple email addresses that are intended to be added as an alias.", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "type": "array" }, "mode": { "default": "addGroupAlias", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "addGroupAlias" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{addMailGroupMemberZoid}/groups/{zgid}": { "description": "To add members to the group and also define their roles in the group.", "put": { "operationId": "addMailGroupMember", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addMailGroupMemberZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailGroupMemberList": [ { "memberEmailId": "rebecca@zylker.com", "role": "moderator" }, { "memberEmailId": "paula@zylker.com", "role": "member" } ], "mode": "addMailGroupMember" }, "schema": { "properties": { "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" }, "role": { "description": "This field specifies the role of the member in the group. The possible values are: \"moderator\", \"member\".", "enum": [ "member", "moderator" ], "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "addMailGroupMember", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "addMailGroupMember" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{changeMemberRoleZoid}/groups/{zgid}": { "description": "To update the role of the group member.", "put": { "operationId": "changeMemberRole", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "changeMemberRoleZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailGroupMemberList": [ { "memberEmailId": "rebecca@zylker.com", "role": "moderator" } ], "mode": "changeMemberRole" }, "schema": { "properties": { "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" }, "role": { "description": "This field specifies the role of the member in the group. The possible values are: \"moderator\", \"member\".", "enum": [ "member", "moderator" ], "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "changeMemberRole", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "changeMemberRole" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{createGroupZoid}/groups": { "description": "To create a new group with the specified settings", "post": { "operationId": "createGroup", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "createGroupZoid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "accessType": "Public", "emailId": "test@zylker.com", "groupDescription": "test group description", "mailGroupMemberList": [ { "memberEmailId": "rebecca@zylker.com", "role": "moderator" } ], "name": "test", "streamsEnabled": true }, "schema": { "properties": { "accessType": { "description": "This field specifies the access type of the group.", "enum": [ "Public", "Organization", "Group", "Moderated" ], "type": "string" }, "emailId": { "description": "This field specifies the email address of the group", "type": "string" }, "groupDescription": { "description": "This field specifies the description of the group.", "type": "string" }, "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" }, "role": { "description": "This field specifies the role of the member in the group. The possible values are: \"moderator\", \"member\".", "enum": [ "member", "moderator" ], "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "description": "This field specifies the name of the group", "type": "string" }, "streamsEnabled": { "description": "This field specifies whether the group is enabled for streams or not.", "type": "boolean" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "URI": { "description": "This field specifies the URI of the group.", "type": "string" }, "accessType": { "description": "This field specifies the access type of the group.", "type": "string" }, "emailId": { "description": "This field specifies the email address of the group", "type": "string" }, "groupDescription": { "description": "This field specifies the description of the group.", "type": "string" }, "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" }, "role": { "description": "This field specifies the role of the member in the group. The possible values are: \"moderator\", \"member\".", "type": "string" } }, "type": "object" }, "type": "array" }, "name": { "description": "This field specifies the name of the group", "type": "string" }, "streamsEnabled": { "description": "This field specifies whether the group is enabled for streams or not.", "type": "boolean" }, "zgid": { "description": "unique identifier of the group.", "format": "int64", "type": "integer" } }, "type": "object" }, "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.CREATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{deleteGroupAliasZoid}/groups/{zgid}": { "description": "To remove email aliases from the group email address.", "put": { "operationId": "deleteGroupAlias", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteGroupAliasZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "aliasList": [ "rebecca@zylker.com" ], "mode": "deleteGroupAlias" }, "schema": { "properties": { "aliasList": { "description": "This field needs to be passed as an array of single or multiple email addresses that are intended to be added as an alias.", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "type": "array" }, "mode": { "default": "deleteGroupAlias", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "deleteGroupAlias" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{deleteGroupZoid}/groups": { "delete": { "operationId": "deleteGroup", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteGroupZoid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "groupList": [ 1855023232323138, 185532323232320130, 185532323230137, 18550134 ] }, "schema": { "properties": { "groupList": { "description": "This field specifies the list of groups", "items": { "description": "This is an array of long, refer parent description for more details", "format": "int64", "type": "integer" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.DELETE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] }, "description": "To create a new group with the specified settings" }, "/api/organization/{deleteMailGroupMemberZoid}/groups/{zgid}": { "description": "To delete existing members from a group", "put": { "operationId": "deleteMailGroupMember", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteMailGroupMemberZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailGroupMemberList": [ { "memberEmailId": "rebecca@zylker.com" } ], "mode": "deleteMailGroupMember" }, "schema": { "properties": { "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "deleteMailGroupMember", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "deleteMailGroupMember" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{enableStreamsZoid}/groups/{zgid}": { "description": "To enable streams for a specific group.", "put": { "operationId": "enableStreams", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "enableStreamsZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "enableStreams" }, "schema": { "properties": { "mode": { "default": "enableStreams", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "enableStreams" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{fetchAllGroupsZoid}/groups": { "description": "To retrieve details of all the groups in the organization.", "get": { "operationId": "fetchAllGroups", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "fetchAllGroupsZoid", "required": true, "schema": { "type": "string" } }, { "description": "start of pagination for group listing", "in": "query", "name": "start", "required": false, "schema": { "type": "string" } }, { "description": "limit of pagination for group listing", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "list of field details to get for group listing", "in": "query", "name": "fields", "required": true, "schema": { "default": "name,emailId,accessType,groupMemberCount,mailModerationcount", "type": "string" } }, { "description": "key to search group listing", "in": "query", "name": "searchKey", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "count": { "format": "int32", "type": "integer" }, "domains": { "description": "This field specifies the list of domains that are allowed to add members to the group.", "items": { "type": "string" }, "type": "array" }, "groups": { "items": { "properties": { "URI": { "description": "This field specifies the URI of the group.", "type": "string" }, "accessType": { "description": "This field specifies the access type of the group.", "type": "string" }, "accountCreationTime": { "description": "This field specifies the account creation time of the group.", "format": "int64", "type": "integer" }, "aliasList": { "description": "This field needs to be passed as an array of single or multiple email addresses that are intended to be added as an alias.", "items": { "type": "string" }, "type": "array" }, "emailId": { "description": "This field specifies the email address of the group", "type": "string" }, "groupAdminSettings": { "properties": { "accessType": { "description": "This field specifies the access type of the group.", "type": "string" }, "adminNotify": { "description": "This field specifies whether the group admin should be notified about the changes made to the group", "type": "boolean" }, "authorNotify": { "description": "This field specifies whether the group should notify the author when a member is added to the group", "type": "boolean" }, "holdOrBounce": { "description": "This field specifies whether the group should hold or bounce the emails sent to the group which are in moderation", "type": "string" }, "isNotToCc": { "description": "This field specifies the email delivery behaviour when the group email address is not specified in the \"To\" or \"Cc\" fields of the outgoing message.", "type": "boolean" }, "mailboxId": { "description": "This field specifies the mailbox ID of the group", "format": "int64", "type": "integer" }, "mailboxSendRights": { "description": "This field specifies whether the group is allowed to send emails from the group email address", "type": "boolean" }, "moderationApprovalOption": { "description": "This field specifies the moderation approval option for the group", "type": "string" }, "moderationTTL": { "description": "This field specifies the time-to-live (TTL) for the moderation approval in seconds.", "format": "int32", "type": "integer" }, "postApprovedNotify": { "description": "This field specifies whether the post-approval should be notified or not", "type": "boolean" }, "spamApproval": { "description": "This field specifies whether the group should approve or reject the emails marked as spam.", "type": "boolean" }, "spamMarkPermission": { "description": "`This field specifies the ability to mark an email or message as spam.", "type": "boolean" }, "suppressMailOnMemAdd": { "description": "This field specifies whether the group should suppress the email notification when a member is added to the group", "type": "boolean" } }, "type": "object" }, "groupDescription": { "description": "This field specifies the description of the group.", "type": "string" }, "groupGeneralSettings": { "properties": { "bounceThreshold": { "description": "This field specifies the bounce threshold for the group.", "format": "int32", "type": "integer" }, "mailboxId": { "description": "This field specifies the mailbox ID of the group", "format": "int64", "type": "integer" }, "notifSubscription": { "description": "This field specifies the notification subscription settings of the group.", "type": "boolean" } }, "type": "object" }, "groupMemberCount": { "description": "This field specifies the count of members in the group.", "format": "int32", "type": "integer" }, "groupRestrictionCount": { "description": "This field specifies the count of group restrictions.", "format": "int32", "type": "integer" }, "groupRestrictionList": { "description": "This field specifies the list of group restrictions.", "items": { "properties": { "access": { "description": "This field specifies the access type of the group Restriction", "type": "string" }, "data": { "description": "This field specifies the data of the group restriction", "type": "string" }, "type": { "description": "This field specifies the type of the group restriction", "type": "string" } }, "type": "object" }, "type": "array" }, "groupTextSettings": { "properties": { "ackStatusText": { "description": "This field specifies the acknowledgment status mail content of the group .", "type": "string" }, "adminMemberApprovalText": { "description": "This field specifies the admin member approval mail content of the group.", "type": "string" }, "adminNonMemberApprovalText": { "description": "This field specifies the admin non-member approval mail content of the group.", "type": "string" }, "autoResponseText": { "description": "This field specifies the auto-response mail content of the group.", "type": "string" }, "bounceText": { "description": "This field specifies the bounce mail content of the group.", "type": "string" }, "isNotToOrCcText": { "description": "This field specifies the email delivery behaviour when the group email address is not specified in the \"To\" or \"Cc\" fields of the outgoing message.", "type": "string" }, "mailboxId": { "description": "This field specifies the mailbox ID of the group", "format": "int64", "type": "integer" }, "memberApprovalText": { "description": "This field specifies the member approval mail content of the group.", "type": "string" }, "rejectText": { "description": "This field specifies the reject mail content of the group.", "type": "string" }, "spamApprovalText": { "description": "This field specifies the spam approval mail content of the group.", "type": "string" }, "subscriptionText": { "description": "This field specifies the subscription mail content of the group.", "type": "string" }, "unSubscriptionText": { "description": "This field specifies the unsubscription mail content of the group.", "type": "string" } }, "type": "object" }, "iamGroupExist": { "description": "This field specifies whether the IAM group exists or not.", "type": "boolean" }, "isLogoExist": { "description": "This field specifies whether the group has a logo or not.", "type": "boolean" }, "isModerator": { "description": "This field specifies whether the member is a moderator of the group or not.", "type": "boolean" }, "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "ackStatus": { "description": "This field specifies the acknowledgment status of the group member.", "type": "boolean" }, "deliveryOption": { "description": "This field specifies the delivery option of the member in the group.", "type": "string" }, "displayName": { "description": "This field specifies the display name of the group member", "type": "string" }, "failureCount": { "description": "This field specifies the failure count of the mails for member in the group.", "format": "int32", "type": "integer" }, "firstName": { "description": "This field specifies the first name of the member.", "type": "string" }, "lastName": { "description": "This field specifies the last name of the member.", "type": "string" }, "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" }, "memberType": { "description": "This field specifies the type of the member in org.", "type": "string" }, "postApproval": { "description": "This field specifies whether the group should approve or reject the posts made by the members.", "type": "string" }, "role": { "description": "This field specifies the role of the member in the group. The possible values are: \"moderator\", \"member\".", "type": "string" }, "sendAsRight": { "description": "This field specifies whether the group member has the right to send emails as the group email address.", "type": "boolean" }, "status": { "description": "This field specifies the status of the group mail member.", "type": "string" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "type": "object" }, "type": "array" }, "mailModerationcount": { "description": "This field specifies the count of mail moderation for the group.", "format": "int32", "type": "integer" }, "mailboxId": { "description": "This field specifies the mailbox ID of the group", "format": "int64", "type": "integer" }, "mbtype": { "description": "This field specifies the mailbox type of the group.", "type": "string" }, "name": { "description": "This field specifies the name of the group", "type": "string" }, "pendingInvitation": { "description": "This field specifies the pending invitation for the group.", "format": "int32", "type": "integer" }, "policyId": { "type": "string" }, "policyName": { "description": "This field specifies the name of the group policy.", "type": "string" }, "streamsEnabled": { "description": "This field specifies whether the group is enabled for streams or not.", "type": "boolean" }, "zgid": { "description": "unique identifier of the group.", "format": "int64", "type": "integer" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.READ" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{fetchSpecificGroupsZoid}/groups/{zgid}": { "description": "To retrieve the details of a specific group in an organization.", "get": { "operationId": "fetchSpecificGroups", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "fetchSpecificGroupsZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "URI": { "description": "This field specifies the URI of the group.", "type": "string" }, "accessType": { "description": "This field specifies the access type of the group.", "type": "string" }, "accountCreationTime": { "description": "This field specifies the account creation time of the group.", "format": "int64", "type": "integer" }, "emailId": { "description": "This field specifies the email address of the group", "type": "string" }, "groupAdminSettings": { "properties": { "accessType": { "description": "This field specifies the access type of the group.", "type": "string" }, "adminNotify": { "description": "This field specifies whether the group admin should be notified about the changes made to the group", "type": "boolean" }, "authorNotify": { "description": "This field specifies whether the group should notify the author when a member is added to the group", "type": "boolean" }, "holdOrBounce": { "description": "This field specifies whether the group should hold or bounce the emails sent to the group which are in moderation", "type": "string" }, "isNotToCc": { "description": "This field specifies the email delivery behaviour when the group email address is not specified in the \"To\" or \"Cc\" fields of the outgoing message.", "type": "boolean" }, "mailboxId": { "description": "This field specifies the mailbox ID of the group", "format": "int64", "type": "integer" }, "mailboxSendRights": { "description": "This field specifies whether the group is allowed to send emails from the group email address", "type": "boolean" }, "moderationApprovalOption": { "description": "This field specifies the moderation approval option for the group", "type": "string" }, "moderationTTL": { "description": "This field specifies the time-to-live (TTL) for the moderation approval in seconds.", "format": "int32", "type": "integer" }, "postApprovedNotify": { "description": "This field specifies whether the post-approval should be notified or not", "type": "boolean" }, "spamApproval": { "description": "This field specifies whether the group should approve or reject the emails marked as spam.", "type": "boolean" }, "spamMarkPermission": { "description": "`This field specifies the ability to mark an email or message as spam.", "type": "boolean" }, "suppressMailOnMemAdd": { "description": "This field specifies whether the group should suppress the email notification when a member is added to the group", "type": "boolean" } }, "type": "object" }, "groupDescription": { "description": "This field specifies the description of the group.", "type": "string" }, "groupGeneralSettings": { "properties": { "bounceThreshold": { "description": "This field specifies the bounce threshold for the group.", "format": "int32", "type": "integer" }, "mailboxId": { "description": "This field specifies the mailbox ID of the group", "format": "int64", "type": "integer" }, "notifSubscription": { "description": "This field specifies the notification subscription settings of the group.", "type": "boolean" } }, "type": "object" }, "groupMemberCount": { "description": "This field specifies the count of members in the group.", "format": "int32", "type": "integer" }, "groupRestrictionCount": { "description": "This field specifies the count of group restrictions.", "format": "int32", "type": "integer" }, "groupRestrictionList": { "description": "This field specifies the list of group restrictions.", "items": { "properties": { "access": { "description": "This field specifies the access type of the group Restriction", "type": "string" }, "data": { "description": "This field specifies the data of the group restriction", "type": "string" }, "type": { "description": "This field specifies the type of the group restriction", "type": "string" } }, "type": "object" }, "type": "array" }, "groupTextSettings": { "properties": { "ackStatusText": { "description": "This field specifies the acknowledgment status mail content of the group .", "type": "string" }, "adminMemberApprovalText": { "description": "This field specifies the admin member approval mail content of the group.", "type": "string" }, "adminNonMemberApprovalText": { "description": "This field specifies the admin non-member approval mail content of the group.", "type": "string" }, "autoResponseText": { "description": "This field specifies the auto-response mail content of the group.", "type": "string" }, "bounceText": { "description": "This field specifies the bounce mail content of the group.", "type": "string" }, "isNotToOrCcText": { "description": "This field specifies the email delivery behaviour when the group email address is not specified in the \"To\" or \"Cc\" fields of the outgoing message.", "type": "string" }, "mailboxId": { "description": "This field specifies the mailbox ID of the group", "format": "int64", "type": "integer" }, "memberApprovalText": { "description": "This field specifies the member approval mail content of the group.", "type": "string" }, "rejectText": { "description": "This field specifies the reject mail content of the group.", "type": "string" }, "spamApprovalText": { "description": "This field specifies the spam approval mail content of the group.", "type": "string" }, "subscriptionText": { "description": "This field specifies the subscription mail content of the group.", "type": "string" }, "unSubscriptionText": { "description": "This field specifies the unsubscription mail content of the group.", "type": "string" } }, "type": "object" }, "iamGroupExist": { "description": "This field specifies whether the IAM group exists or not.", "type": "boolean" }, "isLogoExist": { "description": "This field specifies whether the group has a logo or not.", "type": "boolean" }, "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "ackStatus": { "description": "This field specifies the acknowledgment status of the group member.", "type": "boolean" }, "deliveryOption": { "description": "This field specifies the delivery option of the member in the group.", "type": "string" }, "displayName": { "description": "This field specifies the display name of the group member", "type": "string" }, "failureCount": { "description": "This field specifies the failure count of the mails for member in the group.", "format": "int32", "type": "integer" }, "firstName": { "description": "This field specifies the first name of the member.", "type": "string" }, "lastName": { "description": "This field specifies the last name of the member.", "type": "string" }, "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" }, "memberType": { "description": "This field specifies the type of the member in org.", "type": "string" }, "postApproval": { "description": "This field specifies whether the group should approve or reject the posts made by the members.", "type": "string" }, "role": { "description": "This field specifies the role of the member in the group. The possible values are: \"moderator\", \"member\".", "type": "string" }, "sendAsRight": { "description": "This field specifies whether the group member has the right to send emails as the group email address.", "type": "boolean" }, "status": { "description": "This field specifies the status of the group mail member.", "type": "string" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "type": "object" }, "type": "array" }, "mailModerationcount": { "description": "This field specifies the count of mail moderation for the group.", "format": "int32", "type": "integer" }, "mailboxId": { "description": "This field specifies the mailbox ID of the group", "format": "int64", "type": "integer" }, "mbtype": { "description": "This field specifies the mailbox type of the group.", "type": "string" }, "name": { "description": "This field specifies the name of the group", "type": "string" }, "pendingInvitation": { "description": "This field specifies the pending invitation for the group.", "format": "int32", "type": "integer" }, "policyId": { "type": "string" }, "policyName": { "description": "This field specifies the name of the group policy.", "type": "string" }, "streamsEnabled": { "description": "This field specifies whether the group is enabled for streams or not.", "type": "boolean" }, "zgid": { "description": "unique identifier of the group.", "format": "int64", "type": "integer" } }, "type": "object" }, "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.READ" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{getContentOfEmailHeldForModerationZoid}/groups/{zgid}/moderatedMails/{messageId}": { "description": "To retrieve the content of the email that is held for moderation in a particular group", "get": { "operationId": "getContentOfEmailHeldForModeration", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "getContentOfEmailHeldForModerationZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } }, { "description": "message of mail to view content", "in": "path", "name": "messageId", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "description": "This field specifies the data of the group restriction", "items": { "properties": { "attachments": { "description": "This field specifies the list of attachments that group mail contains", "items": { "properties": { "accId": { "description": "This field specifies the unique zoho mail account ID.", "type": "string" }, "attachId": { "description": "This field specifies the ID of the attachment.", "type": "string" }, "entityId": { "description": "This field specifies the ID of the entity that is attached to the group mail.", "type": "string" }, "entityType": { "description": "This field specifies the type of the entity that is attached to the group mail.", "format": "int32", "type": "integer" }, "fileName": { "description": "This field specifies the name of the attachment file.", "type": "string" }, "fileSize": { "description": "This field specifies the size of the attachment file.", "format": "int32", "type": "integer" } }, "type": "object" }, "type": "array" }, "content": { "description": "This field specifies the content of the group mail.", "type": "string" }, "header": { "description": "This field specifies the header of the group mail.", "type": "string" }, "mailContent": { "description": "This field specifies the content of the group mail.", "type": "string" }, "mailId": { "description": "This field specifies the unique ID of the group mail.", "type": "string" }, "messageId": { "description": "This field specifies the unique message ID of the group mail.", "type": "string" }, "returnPath": { "description": "This field specifies the return path of the group mail.", "type": "string" }, "toAddress": { "description": "This field specifies the \"To\" address of the group mail.", "items": { "type": "string" }, "type": "array" } }, "type": "object" }, "type": "array" }, "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.READ" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{getMailsHeldForModerationZoid}/groups/{zgid}/messages": { "description": "To retrieve all the emails that are held for moderation in a particular group.", "get": { "operationId": "getMailsHeldForModeration", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "getMailsHeldForModerationZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } }, { "description": "start of pagination for moderation mails", "in": "query", "name": "start", "required": false, "schema": { "type": "string" } }, { "description": "limit of pagination for moderation mails", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "key to search for moderation mails", "in": "query", "name": "searchKey", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "description": "This field specifies the data of the group restriction", "items": { "properties": { "fromAddress": { "description": "This field specifies the \"From\" address of the group mail.", "type": "string" }, "hasAttachment": { "description": "This field specifies whether the group mail has an attachment or not.", "format": "int32", "type": "integer" }, "isSpam": { "description": "This field specifies whether the group mail is marked as spam or not.", "type": "boolean" }, "messageId": { "description": "This field specifies the unique message ID of the group mail.", "type": "string" }, "returnPath": { "description": "This field specifies the return path of the group mail.", "type": "string" }, "sender": { "description": "This field specifies the sender of the group mail.", "type": "string" }, "sentDateInGMT": { "description": "This field specifies the sent date of the group mail in GMT.", "format": "int64", "type": "integer" }, "size": { "description": "This field specifies the size of the group mail.", "format": "int32", "type": "integer" }, "subject": { "description": "This field specifies the subject of the group mail.", "type": "string" } }, "type": "object" }, "type": "array" }, "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.READ" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{moderateMessagesZoid}/groups/{zgid}/messages": { "description": "To moderates the email that is held for moderation and delivers the email to the member accounts.", "put": { "operationId": "moderateMessages", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "moderateMessagesZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "messageList": [ "1695363808702000001" ], "status": "reject" }, "schema": { "properties": { "messageList": { "description": "This field specifies the list of messages in the group mail.", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "type": "array" }, "status": { "description": "This field specifies the status of the group mail member.", "enum": [ "accept", "reject" ], "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{updateGroupMemberDetailsZoid}/groups/{zgid}": { "description": "To update the details of members of a group", "put": { "operationId": "updateGroupMemberDetails", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateGroupMemberDetailsZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailGroupMemberList": [ { "ackStatus": false, "memberEmailId": "domainadmin@zylker.com", "postApproval": "accept", "role": "moderator", "status": "deactive" } ], "mode": "updateGroupMemberDetails" }, "schema": { "properties": { "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "ackStatus": { "description": "This field specifies the acknowledgment status of the group member.", "type": "boolean" }, "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" }, "postApproval": { "description": "This field specifies whether the group should approve or reject the posts made by the members.", "enum": [ "accept", "hold", "reject" ], "type": "string" }, "role": { "description": "This field specifies the role of the member in the group. The possible values are: \"moderator\", \"member\".", "enum": [ "member", "moderator" ], "type": "string" }, "status": { "description": "This field specifies the status of the group mail member.", "enum": [ "deactive", "active" ], "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "updateGroupMemberDetails", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "updateGroupMemberDetails" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{updateGroupNameZoid}/groups/{zgid}": { "description": "To change the name of a specific group.", "put": { "operationId": "updateGroupName", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateGroupNameZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "updateGroupName", "name": "test" }, "schema": { "properties": { "mode": { "default": "updateGroupName", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "updateGroupName" ], "type": "string" }, "name": { "description": "This field specifies the name of the group", "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{updateMailGroupAdvOptionsZoid}/groups/{zgid}": { "description": "To change the advanced settings for the group", "put": { "operationId": "updateMailGroupAdvOptions", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateMailGroupAdvOptionsZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "accessType": "Organization", "groupAdminSettings": { "adminNotify": true, "authorNotify": true, "holdOrBounce": "hold", "isNotToCc": true, "mailboxSendRights": false, "postApprovedNotify": false, "spamMarkPermission": false, "suppressMailOnMemAdd": true }, "mode": "updateMailGroupAdvOptions" }, "schema": { "properties": { "accessType": { "description": "This field specifies the access type of the group.", "enum": [ "Public", "Organization", "Group", "Moderated" ], "type": "string" }, "groupAdminSettings": { "properties": { "adminNotify": { "description": "This field specifies whether the group admin should be notified about the changes made to the group", "type": "boolean" }, "authorNotify": { "description": "This field specifies whether the group should notify the author when a member is added to the group", "type": "boolean" }, "holdOrBounce": { "description": "This field specifies whether the group should hold or bounce the emails sent to the group which are in moderation", "enum": [ "hold", "reject" ], "type": "string" }, "isNotToCc": { "description": "This field specifies the email delivery behaviour when the group email address is not specified in the \"To\" or \"Cc\" fields of the outgoing message.", "type": "boolean" }, "mailboxSendRights": { "description": "This field specifies whether the group is allowed to send emails from the group email address", "type": "boolean" }, "postApprovedNotify": { "description": "This field specifies whether the post-approval should be notified or not", "type": "boolean" }, "spamMarkPermission": { "description": "`This field specifies the ability to mark an email or message as spam.", "type": "boolean" }, "suppressMailOnMemAdd": { "description": "This field specifies whether the group should suppress the email notification when a member is added to the group", "type": "boolean" } }, "type": "object" }, "mode": { "default": "updateMailGroupAdvOptions", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "updateMailGroupAdvOptions" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } }, "/api/organization/{updateMemberStatusZoid}/groups/{zgid}": { "description": "To change the status of the members in a group.", "put": { "operationId": "updateMemberStatus", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateMemberStatusZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of a group", "in": "path", "name": "zgid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailGroupMemberList": [ { "memberEmailId": "rebecca@zylker.com", "status": "active" } ], "mode": "updateMemberStatus" }, "schema": { "properties": { "mailGroupMemberList": { "description": "This fields are email addresses that are members of the group.", "items": { "properties": { "memberEmailId": { "description": "This field specifies the email address of the member", "type": "string" }, "status": { "description": "This field specifies the status of the group mail member.", "enum": [ "active", "deactive" ], "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "updateMemberStatus", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "updateMemberStatus" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "status": { "properties": { "code": { "description": "The HTTP status code or application-specific status code returned by the REST API.", "format": "int32", "type": "integer" }, "description": { "description": "Provides a human-readable explanation of the REST API response.", "type": "string" } }, "type": "object" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.groups.ALL", "ZohoMail.organization.groups.UPDATE" ] } ], "tags": [ "groupManagement" ], "x-mcp-group": [ "Group Management" ] } } }, "tags": [ { "name": "groupManagement" } ] }