{ "components": { "securitySchemes": { "iam-oauth2-schema": { "flows": { "authorizationCode": { "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "scopes": { "ZohoMail.organization.accounts.ALL": "Full access to account management", "ZohoMail.organization.accounts.CREATE": "Write access to org accounts", "ZohoMail.organization.accounts.READ": "Read access to org accounts", "ZohoMail.organization.accounts.UPDATE": "update access to org accounts" }, "tokenUrl": "https://accounts.zoho.com/oauth/v2/token" } }, "type": "oauth2" } } }, "info": { "title": "Zohomail cli", "version": "1.0" }, "openapi": "3.0.1", "paths": { "/api/organization/{addEmailAliasZoid}/accounts/{accountId}": { "description": "To add an email alias for a user in the organization.", "put": { "operationId": "addEmailAlias", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addEmailAliasZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "emailAlias": [ "paula@zylker.com" ], "mode": "addEmailAlias", "zuid": "11111111" }, "schema": { "properties": { "emailAlias": { "description": "This field specifies the email alias of the user", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "type": "array" }, "mode": { "default": "addEmailAlias", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "addEmailAlias" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "paula@zylker.com": { "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{addMailForwardZoid}/accounts/{accountId}": { "description": "This API is used to add email forwarding for a user account to a particular email address", "put": { "operationId": "addMailForward", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addMailForwardZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailForward": [ { "mailForwardTo": "paula@zylker.com" } ], "mode": "addMailForward", "zuid": "11111111" }, "schema": { "properties": { "mailForward": { "description": "This field specifies the email forwarding details of the user", "items": { "properties": { "mailForwardTo": { "description": "This field specifies the email address to which the emails should be forwarded", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "addMailForward", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "addMailForward" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{addUserZoid}/accounts": { "description": "To add an user to the organization", "post": { "operationId": "addUser", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addUserZoid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "country": "in", "displayName": "Rebecca", "firstName": "Rebecca", "groupMailList": [ "newgroupmail@zylker.com", "newgroup@zylker.com" ], "language": "En", "lastName": "Anderson", "mobileNumber": "+911234567890", "oneTimePassword": false, "password": "Abc@123", "primaryEmailAddress": "rebecca@zylker.com", "role": "member", "timeZone": "Asia/Kolkata", "userExpiry": 100 }, "schema": { "properties": { "country": { "description": "This field specifies the country of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "displayName": { "description": "This field specifies the display name of the user/mail id", "type": "string" }, "firstName": { "description": "This field specifies the first name of the user", "type": "string" }, "groupMailList": { "description": "This field specifies the group mail list to which the user belongs", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "type": "array" }, "language": { "description": "This field specifies the language of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "lastName": { "description": "This field specifies the last name of the user", "type": "string" }, "mobileNumber": { "description": "This field specifies the mobile number of the user", "type": "string" }, "oneTimePassword": { "description": "This field specifies whether the user should be prompted to change their password on first login", "type": "boolean" }, "password": { "description": "This field specifies the password of the user", "type": "string" }, "primaryEmailAddress": { "description": "This field specifies the primary email address of the user", "type": "string" }, "role": { "description": "This field specifies the role of the user/group member in the organization/group", "enum": [ "member", "admin", "super_admin" ], "type": "string" }, "timeZone": { "description": "This field specifies the time zone of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "userExpiry": { "description": "This field specifies the expiry date of the user account, number of days from the current date or currentmilliseconds of that date", "format": "int32", "type": "integer" } }, "required": [ "password", "primaryEmailAddress" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "accountCreationTime": { "description": "This field specifies the account creation time of the user", "format": "int64", "type": "integer" }, "accountDisplayName": { "description": "This field specifies the display name of the user account", "type": "string" }, "accountId": { "description": "This field specifies the unique identifier of the user account", "type": "string" }, "accountName": { "description": "This field specifies the name of the user account", "type": "string" }, "activeSyncEnabled": { "description": "This field specifies whether ActiveSync is enabled for the user", "type": "boolean" }, "address": { "properties": { "city": { "description": "This field specifies the city associated with the user account", "type": "string" }, "country": { "description": "This field specifies the country of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "postalCode": { "description": "This field specifies the postal code associated with the user account", "type": "string" }, "state": { "description": "This field specifies the state associated with the user account", "type": "string" }, "streetAddr": { "description": "This field specifies the street address associated with the user account", "type": "string" } }, "type": "object" }, "allowedStorage": { "description": "This field specifies the storage allowed for the user", "format": "int32", "type": "integer" }, "country": { "description": "This field specifies the country of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "customFields": { "description": "This field specifies the custom fields associated with the user account", "items": { "properties": { "propertyName": { "type": "string" }, "propertyValue": { "type": "string" } }, "type": "object" }, "type": "array" }, "displayName": { "description": "This field specifies the display name of the user/mail id", "type": "string" }, "ediscoveryStorage": { "properties": { "ediscoveryAllowedStorage": { "description": "This field specifies the eDiscovery storage allowed for the user", "format": "int32", "type": "integer" }, "ediscoveryUsedStorage": { "description": "This field specifies the eDiscovery storage used by the user", "format": "int32", "type": "integer" }, "iseDiscoveryStorageEnabled": { "description": "This field specifies whether eDiscovery storage is enabled for the user", "type": "boolean" } }, "type": "object" }, "emailAddress": { "description": "This field specifies the email address details of the user", "items": { "properties": { "isAlias": { "description": "This field specifies whether the email address is an alias", "type": "boolean" }, "isConfirmed": { "description": "This field specifies whether the email address is confirmed", "type": "boolean" }, "isPrimary": { "description": "This field specifies whether the email address is a primary", "type": "boolean" }, "mailId": { "description": "This field specifies the mail ID of the user", "type": "string" } }, "type": "object" }, "type": "array" }, "enabled": { "description": "This field specifies whether the user account is enabled or not", "type": "boolean" }, "extraEDiscoveryStorage": { "type": "object" }, "extraStorage": { "type": "object" }, "firstName": { "description": "This field specifies the first name of the user", "type": "string" }, "gender": { "description": "This field specifies gender of the user", "type": "string" }, "groupList": { "description": "This field specifies the list of groups to which the user belongs", "items": { "properties": { "emailId": { "type": "string" }, "isLogoExist": { "description": "This field specifies whether the group/user has a logo", "type": "boolean" }, "name": { "description": "This field specifies the name of the group", "type": "string" }, "role": { "description": "This field specifies the role of the user/group member in the organization/group", "type": "string" }, "zgid": { "description": "unique identifier of the group.", "format": "int64", "type": "integer" } }, "type": "object" }, "type": "array" }, "iamStatus": { "description": "This field specifies the IAM status of the user", "format": "int32", "type": "integer" }, "iamUserRole": { "description": "This field specifies the IAM user role of the user", "type": "string" }, "imapAccessEnabled": { "description": "This field specifies whether IMAP access is enabled for the user", "type": "boolean" }, "imapBlocked": { "description": "This field specifies whether IMAP access is blocked for the user", "type": "boolean" }, "incomingBlocked": { "description": "This field specifies whether incoming emails are blocked for the user", "type": "boolean" }, "incomingUserName": { "description": "This field specifies the incoming username for the user", "type": "string" }, "isCustomAdmin": { "description": "This field specifies whether the user is a custom admin", "type": "boolean" }, "isLogoExist": { "description": "This field specifies whether the group/user has a logo", "type": "boolean" }, "language": { "description": "This field specifies the language of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "lastLogin": { "description": "This field specifies the last login time of the user", "format": "int64", "type": "integer" }, "lastName": { "description": "This field specifies the last name of the user", "type": "string" }, "lastPasswordReset": { "description": "This field specifies the last password reset time of the user", "format": "int64", "type": "integer" }, "locationName": { "description": "This field specifies the name of the location associated with the user account", "type": "string" }, "mailboxAddress": { "description": "This field specifies the mailbox address of the user", "type": "string" }, "mailboxCreationTime": { "description": "This field specifies the mailbox creation time of the user", "format": "int64", "type": "integer" }, "mailboxStatus": { "description": "This field specifies the mailbox status of the user", "type": "string" }, "mobileNumber": { "description": "This field specifies the mobile number of the user", "type": "string" }, "mxStatus": { "description": "This field specifies the MX status of the user", "type": "boolean" }, "outgoingBlocked": { "description": "This field specifies whether outgoing emails are blocked for the user", "type": "boolean" }, "phoneNumer": { "description": "This field specifies the phone number of the user", "type": "string" }, "planStorage": { "description": "This field specifies the storage allocated to the user based on their plan", "format": "int32", "type": "integer" }, "planType": { "description": "This field specifies the plan type of the user account", "format": "int32", "type": "integer" }, "policyId": { "properties": { "1082700000192558003": { "type": "string" }, "zoid": { "description": "unique identifier of the organization.", "format": "int64", "type": "integer" } }, "type": "object" }, "popAccessEnabled": { "description": "This field specifies whether POP access is enabled for the user", "type": "boolean" }, "popBlocked": { "description": "This field specifies whether POP access is blocked for the user", "type": "boolean" }, "popFetchTime": { "description": "This field specifies the time when the POP fetch was last performed for the user's email account", "format": "int64", "type": "integer" }, "primaryEmailAddress": { "description": "This field specifies the primary email address of the user", "type": "string" }, "role": { "description": "This field specifies the role of the user/group member in the organization/group", "type": "string" }, "sendMailDetails": { "description": "This field specifies the details of the email sent by the user", "items": { "properties": { "connectionType": { "description": "This field specifies the connection type for the user's email account", "type": "string" }, "displayName": { "description": "This field specifies the display name of the user/mail id", "type": "string" }, "fromAddress": { "description": "This field specifies the email address from which the email is sent", "type": "string" }, "mode": { "description": "This field specifies the mode in which the operation should be performed", "type": "string" }, "sendMailId": { "description": "This field specifies the unique identifier of the email sent by the user", "type": "string" }, "serverName": { "description": "This field specifies the smtp server for the user's email account", "type": "string" }, "serverPort": { "description": "This field specifies the smtp server port for the user's email account", "format": "int32", "type": "integer" }, "signatureId": { "type": "string" }, "smtpConnection": { "description": "This field specifies the SMTP connection details for the user's email account", "format": "int32", "type": "integer" }, "status": { "description": "This field specifies the status of the user account", "type": "boolean" }, "userName": { "description": "This field specifies the username for the user's email account", "type": "string" }, "validated": { "description": "This field specifies whether the email address is validated", "type": "boolean" }, "validationRequired": { "description": "This field specifies whether validation is required for the email address", "type": "boolean" }, "validationState": { "description": "This field specifies the validation state of the email address", "format": "int32", "type": "integer" } }, "type": "object" }, "type": "array" }, "sequence": { "format": "int32", "type": "integer" }, "smtpStatus": { "description": "This field specifies the SMTP status of the user's email account", "type": "boolean" }, "spamcheckEnabled": { "description": "This field specifies whether spam check is enabled for the user", "type": "boolean" }, "status": { "description": "This field specifies the status of the user account", "type": "boolean" }, "tfaEnabled": { "description": "This field specifies whether two-factor authentication is enabled for the user", "type": "boolean" }, "timeZone": { "description": "This field specifies the time zone of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "type": { "description": "This field specifies the type of the user account", "type": "string" }, "usedStorage": { "description": "This field specifies the storage used by the user", "format": "int32", "type": "integer" }, "userExpiry": { "description": "This field specifies the expiry date of the user account, number of days from the current date or currentmilliseconds of that date", "format": "int64", "type": "integer" }, "webBlocked": { "description": "This field specifies whether web access is blocked for the user", "type": "boolean" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.CREATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{changeUserRoleZoid}/accounts": { "description": "To change the role of any user in the organization", "put": { "operationId": "changeUserRole", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "changeUserRoleZoid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "changeRole", "role": "user", "userList": [ "8887771" ] }, "schema": { "properties": { "mode": { "default": "changeRole", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "changeRole" ], "type": "string" }, "role": { "description": "This field specifies the role of the user/group member in the organization/group", "enum": [ "member", "admin" ], "type": "string" }, "userList": { "description": "This field specifies the list of zuid in the organization", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "type": "array" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "8887771": { "type": "boolean" } }, "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{deleteEmailAliasZoid}/accounts/{accountId}": { "description": "To remove the email alias for the user in the organization.", "put": { "operationId": "deleteEmailAlias", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteEmailAliasZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "emailAlias": [ "paula@zylker.com" ], "mode": "deleteEmailAlias", "zuid": "11111111" }, "schema": { "properties": { "emailAlias": { "description": "This field specifies the email alias of the user", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "type": "array" }, "mode": { "default": "deleteEmailAlias", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "deleteEmailAlias" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{deleteMailForwardZoid}/accounts/{accountId}": { "description": "TThis API is used to remove/delete email forwarding configured for an email address", "put": { "operationId": "deleteMailForward", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteMailForwardZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailForward": [ { "mailForwardTo": "paula@zylker.com" } ], "mode": "deleteMailForward", "zuid": 1111111111111 }, "schema": { "properties": { "mailForward": { "description": "This field specifies the email forwarding details of the user", "items": { "properties": { "mailForwardTo": { "description": "This field specifies the email address to which the emails should be forwarded", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "deleteMailForward", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "deleteMailForward" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{deleteUserZoid}/accounts": { "delete": { "operationId": "deleteUser", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteUserZoid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "emailList": [ "rebecca@zylker.com", "paula@zylker.com" ] }, "schema": { "properties": { "emailList": { "description": "This field specifies the list of email addresses", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "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.accounts.ALL", "ZohoMail.organization.accounts.CREATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] }, "description": "To delete a user's mailbox" }, "/api/organization/{deleteZohoMailCopyZoid}/accounts/{accountId}": { "description": "This API is used to delete the Zoho Mail copy of the email after forwarding the email.", "put": { "operationId": "deleteZohoMailCopy", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteZohoMailCopyZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "deleteCopy": "false", "mode": "deleteZohoMailCopy", "zuid": "11111111" }, "schema": { "properties": { "deleteCopy": { "description": "This field specifies whether a copy of the email should be deleted after forwarding", "type": "string" }, "mode": { "default": "deleteZohoMailCopy", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "deleteZohoMailCopy" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{disableMailAccountZoid}/accounts/{accountId}": { "description": "To disable the mail account functionality for a user account", "put": { "operationId": "disableMailAccount", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "disableMailAccountZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "disableMailAccount", "zuid": 11111111111111 }, "schema": { "properties": { "mode": { "default": "disableMailAccount", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "disableMailAccount" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{disableMailForwardZoid}/accounts/{accountId}": { "description": "This API is used to disable email forwarding for a user account", "put": { "operationId": "disableMailForward", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "disableMailForwardZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailForward": [ { "mailForwardTo": "paula@zylker.com" } ], "mode": "disableMailForward", "zuid": 111111121212211 }, "schema": { "properties": { "mailForward": { "description": "This field specifies the email forwarding details of the user", "items": { "properties": { "mailForwardTo": { "description": "This field specifies the email address to which the emails should be forwarded", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "disableMailForward", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "disableMailForward" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{disableUserZoid}/accounts/{accountId}": { "description": "To disable a user", "put": { "operationId": "disableUser", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "disableUserZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "blockIncoming": "true", "mode": "disableUser", "removeAlias": "true", "removeGroupMembership": "true", "removeMailforward": "true", "zuid": "11111111" }, "schema": { "properties": { "blockIncoming": { "description": "This field specifies whether incoming emails are blocked for the user", "type": "string" }, "mode": { "default": "disableUser", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "disableUser" ], "type": "string" }, "removeAlias": { "description": "This field specifies whether the email alias should be removed for the user", "type": "string" }, "removeGroupMembership": { "description": "This field specifies whether the user should be removed from the group membership", "type": "string" }, "removeMailforward": { "description": "This field specifies whether the mail forwarding should be removed for the user", "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{enableMailAccountZoid}/accounts/{accountId}": { "description": "To enable the mail account functionality for a user account", "put": { "operationId": "enableMailAccount", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "enableMailAccountZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "enableMailAccount", "zuid": 111212121211111 }, "schema": { "properties": { "mode": { "default": "enableMailAccount", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "enableMailAccount" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{enableMailForwardZoid}/accounts/{accountId}": { "description": "This API is used to enable email forwarding for a user account", "put": { "operationId": "enableMailForward", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "enableMailForwardZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailForward": [ { "mailForwardTo": "paula@zylker.com" } ], "mode": "enableMailForward", "zuid": 1121212121111111 }, "schema": { "properties": { "mailForward": { "description": "This field specifies the email forwarding details of the user", "items": { "properties": { "mailForwardTo": { "description": "This field specifies the email address to which the emails should be forwarded", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "enableMailForward", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "enableMailForward" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{enableUserZoid}/accounts/{accountId}": { "description": "To enable a user.", "put": { "operationId": "enableUser", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "enableUserZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "enableUser", "unblockIncoming": "true", "zuid": "11111111" }, "schema": { "properties": { "mode": { "default": "enableUser", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "enableUser" ], "type": "string" }, "unblockIncoming": { "description": "This field specifies whether incoming emails should be unblocked for the user", "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{fetchOrgUsersDetailsZoid}/accounts": { "description": "To fetch all the user's details for the specified organization", "get": { "operationId": "fetchOrgUsersDetails", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "fetchOrgUsersDetailsZoid", "required": true, "schema": { "type": "string" } }, { "description": "start of pagination for users listing", "in": "query", "name": "start", "required": false, "schema": { "type": "string" } }, { "description": "limit of pagination for users listing", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } }, { "description": "list of field details to get for users listing", "in": "query", "name": "fields", "required": true, "schema": { "default": "displayName,primaryEmailAddress,lastLogin,mobileNumber,locationName,status", "type": "string" } }, { "description": "key to search user listing", "in": "query", "name": "searchKey", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "items": { "properties": { "accountCreationTime": { "description": "This field specifies the account creation time of the user", "format": "int64", "type": "integer" }, "accountDisplayName": { "description": "This field specifies the display name of the user account", "type": "string" }, "accountId": { "description": "This field specifies the unique identifier of the user account", "type": "string" }, "accountName": { "description": "This field specifies the name of the user account", "type": "string" }, "activeSyncEnabled": { "description": "This field specifies whether ActiveSync is enabled for the user", "type": "boolean" }, "address": { "properties": { "city": { "description": "This field specifies the city associated with the user account", "type": "string" }, "country": { "description": "This field specifies the country of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "postalCode": { "description": "This field specifies the postal code associated with the user account", "type": "string" }, "state": { "description": "This field specifies the state associated with the user account", "type": "string" }, "streetAddr": { "description": "This field specifies the street address associated with the user account", "type": "string" } }, "type": "object" }, "allowedStorage": { "description": "This field specifies the storage allowed for the user", "format": "int32", "type": "integer" }, "basicStorage": { "type": "string" }, "country": { "description": "This field specifies the country of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "customFields": { "description": "This field specifies the custom fields associated with the user account", "items": { "properties": { "propertyName": { "type": "string" }, "propertyValue": { "type": "string" } }, "type": "object" }, "type": "array" }, "displayName": { "description": "This field specifies the display name of the user/mail id", "type": "string" }, "ediscoveryStorage": { "properties": { "ediscoveryAllowedStorage": { "description": "This field specifies the eDiscovery storage allowed for the user", "format": "int32", "type": "integer" }, "ediscoveryUsedStorage": { "description": "This field specifies the eDiscovery storage used by the user", "format": "int32", "type": "integer" }, "iseDiscoveryStorageEnabled": { "description": "This field specifies whether eDiscovery storage is enabled for the user", "type": "boolean" } }, "type": "object" }, "emailAddress": { "description": "This field specifies the email address details of the user", "items": { "properties": { "isAlias": { "description": "This field specifies whether the email address is an alias", "type": "boolean" }, "isConfirmed": { "description": "This field specifies whether the email address is confirmed", "type": "boolean" }, "isPrimary": { "description": "This field specifies whether the email address is a primary", "type": "boolean" }, "mailId": { "description": "This field specifies the mail ID of the user", "type": "string" } }, "type": "object" }, "type": "array" }, "enabled": { "description": "This field specifies whether the user account is enabled or not", "type": "boolean" }, "extraEDiscoveryStorage": { "properties": { "1 gb": { "format": "int32", "type": "integer" } }, "type": "object" }, "extraStorage": { "properties": { "1 gb": { "format": "int32", "type": "integer" }, "2 gb": { "format": "int32", "type": "integer" } }, "type": "object" }, "firstName": { "description": "This field specifies the first name of the user", "type": "string" }, "gender": { "description": "This field specifies gender of the user", "type": "string" }, "iamStatus": { "description": "This field specifies the IAM status of the user", "format": "int32", "type": "integer" }, "iamUserRole": { "description": "This field specifies the IAM user role of the user", "type": "string" }, "imapAccessEnabled": { "description": "This field specifies whether IMAP access is enabled for the user", "type": "boolean" }, "imapBlocked": { "description": "This field specifies whether IMAP access is blocked for the user", "type": "boolean" }, "incomingBlocked": { "description": "This field specifies whether incoming emails are blocked for the user", "type": "boolean" }, "incomingUserName": { "description": "This field specifies the incoming username for the user", "type": "string" }, "isCustomAdmin": { "description": "This field specifies whether the user is a custom admin", "type": "boolean" }, "isLogoExist": { "description": "This field specifies whether the group/user has a logo", "type": "boolean" }, "language": { "description": "This field specifies the language of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "lastClient": { "type": "string" }, "lastLogin": { "description": "This field specifies the last login time of the user", "format": "int64", "type": "integer" }, "lastName": { "description": "This field specifies the last name of the user", "type": "string" }, "lastPasswordReset": { "description": "This field specifies the last password reset time of the user", "format": "int64", "type": "integer" }, "mailboxAddress": { "description": "This field specifies the mailbox address of the user", "type": "string" }, "mailboxCreationTime": { "description": "This field specifies the mailbox creation time of the user", "format": "int64", "type": "integer" }, "mailboxStatus": { "description": "This field specifies the mailbox status of the user", "type": "string" }, "mobileNumber": { "description": "This field specifies the mobile number of the user", "type": "string" }, "mxStatus": { "description": "This field specifies the MX status of the user", "type": "boolean" }, "outgoingBlocked": { "description": "This field specifies whether outgoing emails are blocked for the user", "type": "boolean" }, "phoneNumer": { "description": "This field specifies the phone number of the user", "type": "string" }, "planStorage": { "description": "This field specifies the storage allocated to the user based on their plan", "format": "int32", "type": "integer" }, "planType": { "description": "This field specifies the plan type of the user account", "format": "int32", "type": "integer" }, "policyId": { "properties": { "1082700000192558003": { "type": "string" }, "zoid": { "description": "unique identifier of the organization.", "format": "int64", "type": "integer" } }, "type": "object" }, "popAccessEnabled": { "description": "This field specifies whether POP access is enabled for the user", "type": "boolean" }, "popBlocked": { "description": "This field specifies whether POP access is blocked for the user", "type": "boolean" }, "popFetchTime": { "description": "This field specifies the time when the POP fetch was last performed for the user's email account", "format": "int64", "type": "integer" }, "primaryEmailAddress": { "description": "This field specifies the primary email address of the user", "type": "string" }, "role": { "description": "This field specifies the role of the user/group member in the organization/group", "type": "string" }, "sendMailDetails": { "description": "This field specifies the details of the email sent by the user", "items": { "properties": { "connectionType": { "description": "This field specifies the connection type for the user's email account", "type": "string" }, "displayName": { "description": "This field specifies the display name of the user/mail id", "type": "string" }, "fromAddress": { "description": "This field specifies the email address from which the email is sent", "type": "string" }, "mode": { "description": "This field specifies the mode in which the operation should be performed", "type": "string" }, "sendMailId": { "description": "This field specifies the unique identifier of the email sent by the user", "type": "string" }, "serverName": { "description": "This field specifies the smtp server for the user's email account", "type": "string" }, "serverPort": { "description": "This field specifies the smtp server port for the user's email account", "format": "int32", "type": "integer" }, "signatureId": { "type": "string" }, "smtpConnection": { "description": "This field specifies the SMTP connection details for the user's email account", "format": "int32", "type": "integer" }, "status": { "description": "This field specifies the status of the user account", "type": "boolean" }, "userName": { "description": "This field specifies the username for the user's email account", "type": "string" }, "validated": { "description": "This field specifies whether the email address is validated", "type": "boolean" }, "validationRequired": { "description": "This field specifies whether validation is required for the email address", "type": "boolean" }, "validationState": { "description": "This field specifies the validation state of the email address", "format": "int32", "type": "integer" } }, "type": "object" }, "type": "array" }, "sequence": { "format": "int32", "type": "integer" }, "smtpStatus": { "description": "This field specifies the SMTP status of the user's email account", "type": "boolean" }, "spamcheckEnabled": { "description": "This field specifies whether spam check is enabled for the user", "type": "boolean" }, "status": { "description": "This field specifies the status of the user account", "type": "boolean" }, "tfaEnabled": { "description": "This field specifies whether two-factor authentication is enabled for the user", "type": "boolean" }, "timeZone": { "description": "This field specifies the time zone of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "type": { "description": "This field specifies the type of the user account", "type": "string" }, "usedStorage": { "description": "This field specifies the storage used by the user", "format": "int32", "type": "integer" }, "userExpiry": { "description": "This field specifies the expiry date of the user account, number of days from the current date or currentmilliseconds of that date", "format": "int64", "type": "integer" }, "webBlocked": { "description": "This field specifies whether web access is blocked for the user", "type": "boolean" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "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.accounts.ALL", "ZohoMail.organization.accounts.READ" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{fetchUserZoid}/accounts/{zuid}": { "description": "To fetch all the user's details for the specified organization", "get": { "operationId": "fetchUser", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "fetchUserZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of user", "in": "path", "name": "zuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "accountCreationTime": { "description": "This field specifies the account creation time of the user", "format": "int64", "type": "integer" }, "accountDisplayName": { "description": "This field specifies the display name of the user account", "type": "string" }, "accountId": { "description": "This field specifies the unique identifier of the user account", "type": "string" }, "accountName": { "description": "This field specifies the name of the user account", "type": "string" }, "activeSyncEnabled": { "description": "This field specifies whether ActiveSync is enabled for the user", "type": "boolean" }, "address": { "properties": { "city": { "description": "This field specifies the city associated with the user account", "type": "string" }, "country": { "description": "This field specifies the country of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "postalCode": { "description": "This field specifies the postal code associated with the user account", "type": "string" }, "state": { "description": "This field specifies the state associated with the user account", "type": "string" }, "streetAddr": { "description": "This field specifies the street address associated with the user account", "type": "string" } }, "type": "object" }, "allowedStorage": { "description": "This field specifies the storage allowed for the user", "format": "int32", "type": "integer" }, "basicStorage": { "type": "string" }, "country": { "description": "This field specifies the country of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "customFields": { "description": "This field specifies the custom fields associated with the user account", "items": { "properties": { "propertyName": { "type": "string" }, "propertyValue": { "type": "string" } }, "type": "object" }, "type": "array" }, "displayName": { "description": "This field specifies the display name of the user/mail id", "type": "string" }, "ediscoveryStorage": { "properties": { "ediscoveryAllowedStorage": { "description": "This field specifies the eDiscovery storage allowed for the user", "format": "int32", "type": "integer" }, "ediscoveryUsedStorage": { "description": "This field specifies the eDiscovery storage used by the user", "format": "int32", "type": "integer" }, "iseDiscoveryStorageEnabled": { "description": "This field specifies whether eDiscovery storage is enabled for the user", "type": "boolean" } }, "type": "object" }, "emailAddress": { "description": "This field specifies the email address details of the user", "items": { "properties": { "isAlias": { "description": "This field specifies whether the email address is an alias", "type": "boolean" }, "isConfirmed": { "description": "This field specifies whether the email address is confirmed", "type": "boolean" }, "isPrimary": { "description": "This field specifies whether the email address is a primary", "type": "boolean" }, "mailId": { "description": "This field specifies the mail ID of the user", "type": "string" } }, "type": "object" }, "type": "array" }, "enabled": { "description": "This field specifies whether the user account is enabled or not", "type": "boolean" }, "extraEDiscoveryStorage": { "properties": { "1 gb": { "format": "int32", "type": "integer" } }, "type": "object" }, "extraStorage": { "properties": { "1 gb": { "format": "int32", "type": "integer" }, "2 gb": { "format": "int32", "type": "integer" } }, "type": "object" }, "firstName": { "description": "This field specifies the first name of the user", "type": "string" }, "gender": { "description": "This field specifies gender of the user", "type": "string" }, "iamStatus": { "description": "This field specifies the IAM status of the user", "format": "int32", "type": "integer" }, "iamUserRole": { "description": "This field specifies the IAM user role of the user", "type": "string" }, "imapAccessEnabled": { "description": "This field specifies whether IMAP access is enabled for the user", "type": "boolean" }, "imapBlocked": { "description": "This field specifies whether IMAP access is blocked for the user", "type": "boolean" }, "incomingBlocked": { "description": "This field specifies whether incoming emails are blocked for the user", "type": "boolean" }, "incomingUserName": { "description": "This field specifies the incoming username for the user", "type": "string" }, "isCustomAdmin": { "description": "This field specifies whether the user is a custom admin", "type": "boolean" }, "isLogoExist": { "description": "This field specifies whether the group/user has a logo", "type": "boolean" }, "language": { "description": "This field specifies the language of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "lastClient": { "type": "string" }, "lastLogin": { "description": "This field specifies the last login time of the user", "format": "int64", "type": "integer" }, "lastName": { "description": "This field specifies the last name of the user", "type": "string" }, "lastPasswordReset": { "description": "This field specifies the last password reset time of the user", "format": "int64", "type": "integer" }, "mailboxAddress": { "description": "This field specifies the mailbox address of the user", "type": "string" }, "mailboxCreationTime": { "description": "This field specifies the mailbox creation time of the user", "format": "int64", "type": "integer" }, "mailboxStatus": { "description": "This field specifies the mailbox status of the user", "type": "string" }, "mobileNumber": { "description": "This field specifies the mobile number of the user", "type": "string" }, "mxStatus": { "description": "This field specifies the MX status of the user", "type": "boolean" }, "outgoingBlocked": { "description": "This field specifies whether outgoing emails are blocked for the user", "type": "boolean" }, "phoneNumer": { "description": "This field specifies the phone number of the user", "type": "string" }, "planStorage": { "description": "This field specifies the storage allocated to the user based on their plan", "format": "int32", "type": "integer" }, "planType": { "description": "This field specifies the plan type of the user account", "format": "int32", "type": "integer" }, "policyId": { "properties": { "1082700000192558003": { "type": "string" }, "zoid": { "description": "unique identifier of the organization.", "format": "int64", "type": "integer" } }, "type": "object" }, "popAccessEnabled": { "description": "This field specifies whether POP access is enabled for the user", "type": "boolean" }, "popBlocked": { "description": "This field specifies whether POP access is blocked for the user", "type": "boolean" }, "popFetchTime": { "description": "This field specifies the time when the POP fetch was last performed for the user's email account", "format": "int64", "type": "integer" }, "primaryEmailAddress": { "description": "This field specifies the primary email address of the user", "type": "string" }, "role": { "description": "This field specifies the role of the user/group member in the organization/group", "type": "string" }, "sendMailDetails": { "description": "This field specifies the details of the email sent by the user", "items": { "properties": { "connectionType": { "description": "This field specifies the connection type for the user's email account", "type": "string" }, "displayName": { "description": "This field specifies the display name of the user/mail id", "type": "string" }, "fromAddress": { "description": "This field specifies the email address from which the email is sent", "type": "string" }, "mode": { "description": "This field specifies the mode in which the operation should be performed", "type": "string" }, "sendMailId": { "description": "This field specifies the unique identifier of the email sent by the user", "type": "string" }, "serverName": { "description": "This field specifies the smtp server for the user's email account", "type": "string" }, "serverPort": { "description": "This field specifies the smtp server port for the user's email account", "format": "int32", "type": "integer" }, "signatureId": { "type": "string" }, "smtpConnection": { "description": "This field specifies the SMTP connection details for the user's email account", "format": "int32", "type": "integer" }, "status": { "description": "This field specifies the status of the user account", "type": "boolean" }, "userName": { "description": "This field specifies the username for the user's email account", "type": "string" }, "validated": { "description": "This field specifies whether the email address is validated", "type": "boolean" }, "validationRequired": { "description": "This field specifies whether validation is required for the email address", "type": "boolean" }, "validationState": { "description": "This field specifies the validation state of the email address", "format": "int32", "type": "integer" } }, "type": "object" }, "type": "array" }, "sequence": { "format": "int32", "type": "integer" }, "smtpStatus": { "description": "This field specifies the SMTP status of the user's email account", "type": "boolean" }, "spamcheckEnabled": { "description": "This field specifies whether spam check is enabled for the user", "type": "boolean" }, "status": { "description": "This field specifies the status of the user account", "type": "boolean" }, "tfaEnabled": { "description": "This field specifies whether two-factor authentication is enabled for the user", "type": "boolean" }, "timeZone": { "description": "This field specifies the time zone of the user, refer https://www.zoho.com/sites/zweb/images/mail/country_-_language_-_timezone.xlsx", "type": "string" }, "type": { "description": "This field specifies the type of the user account", "type": "string" }, "usedStorage": { "description": "This field specifies the storage used by the user", "format": "int32", "type": "integer" }, "userExpiry": { "description": "This field specifies the expiry date of the user account, number of days from the current date or currentmilliseconds of that date", "format": "int64", "type": "integer" }, "webBlocked": { "description": "This field specifies whether web access is blocked for the user", "type": "boolean" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.READ" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{resendMailForwardVerficationMailZoid}/accounts/{accountId}": { "description": "This API is used to resend the verification email for confirming the email forwarding to the account", "put": { "operationId": "resendMailForwardVerficationMail", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "resendMailForwardVerficationMailZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailForward": [ { "mailForwardTo": "paula@zylker.com" } ], "mode": "resendMailForwardVerficationMail", "zuid": "11111111" }, "schema": { "properties": { "mailForward": { "description": "This field specifies the email forwarding details of the user", "items": { "properties": { "mailForwardTo": { "description": "This field specifies the email address to which the emails should be forwarded", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "resendMailForwardVerficationMail", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "resendMailForwardVerficationMail" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{resetUserPasswordZoid}/accounts/{accountId}": { "description": "To reset the password of a user in the organization", "put": { "operationId": "resetUserPassword", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "resetUserPasswordZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "resetUserPassword", "password": "asdf@123", "zuid": "1112121" }, "schema": { "properties": { "mode": { "default": "resetPassword", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "resetPassword" ], "type": "string" }, "password": { "description": "This field specifies the password of the user", "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{updateIMAPStatusZoid}/accounts/{accountId}": { "description": "To change the IMAP status of a user from enabled to disabled or vice-versa", "put": { "operationId": "updateIMAPStatus", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateIMAPStatusZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "imapAccessEnabled": "true", "mode": "updateIMAPStatus", "zuid": "1111111" }, "schema": { "properties": { "imapAccessEnabled": { "description": "This field specifies whether IMAP access is enabled for the user", "type": "string" }, "mode": { "default": "updateIMAPStatus", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "updateIMAPStatus" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{updateIncomingStatusZoid}/accounts/{accountId}": { "description": "To change the incoming status of a user from enabled to disabled or vice-versa.", "put": { "operationId": "updateIncomingStatus", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateIncomingStatusZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "incomingBlocked": "true", "mode": "updateOutgoingStatus", "zuid": "1112233333" }, "schema": { "properties": { "incomingBlocked": { "description": "This field specifies whether incoming emails are blocked for the user", "type": "string" }, "mode": { "default": "updateIncomingStatus", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "updateIncomingStatus" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{updateMobileSyncStatusZoid}/accounts/{accountId}": { "description": "To change the ActiveSync status of a user from enabled to disabled or vice-versa.", "put": { "operationId": "updateMobileSyncStatus", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateMobileSyncStatusZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "activeSyncEnabled": "true", "mode": "updateMobileSyncStatus", "zuid": "121212121" }, "schema": { "properties": { "activeSyncEnabled": { "description": "This field specifies whether ActiveSync is enabled for the user", "type": "string" }, "mode": { "default": "updateMobileSyncStatus", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "updateMobileSyncStatus" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{updateOutgoingStatusZoid}/accounts/{accountId}": { "description": "To change the outgoing status of a user from enabled to disabled or vice-versa.", "put": { "operationId": "updateOutgoingStatus", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateOutgoingStatusZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "updateOutgoingStatus", "outgoingBlocked": "true", "zuid": "1112233333" }, "schema": { "properties": { "mode": { "default": "updateOutgoingStatus", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "updateOutgoingStatus" ], "type": "string" }, "outgoingBlocked": { "description": "This field specifies whether outgoing emails are blocked for the user", "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{updatePOPStatusZoid}/accounts/{accountId}": { "description": "To change the POP status of a user from enabled to disabled or vice-versa", "put": { "operationId": "updatePOPStatus", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updatePOPStatusZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "updatePOPStatus", "popAccessEnabled": "true", "zuid": "1111111" }, "schema": { "properties": { "mode": { "default": "updatePOPStatus", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "updatePOPStatus" ], "type": "string" }, "popAccessEnabled": { "description": "This field specifies whether POP access is enabled for the user", "type": "string" }, "zuid": { "description": "unique identifier of the user.", "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } }, "/api/organization/{verifyMailForwardZoid}/accounts/{accountId}": { "description": "This API is used to verify email forwarding for a user account.", "put": { "operationId": "verifyMailForward", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "verifyMailForwardZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of Mail account", "in": "path", "name": "accountId", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mailForward": [ { "confirmKey": "NfrhjksBj34", "mailForwardTo": "paula@zylker.com" } ], "mode": "verifyMailForward", "zuid": 112121211111111 }, "schema": { "properties": { "mailForward": { "description": "This field specifies the email forwarding details of the user", "items": { "properties": { "confirmKey": { "description": "This field specifies the confirmation key for the user to verify mail forwarding", "type": "string" }, "mailForwardTo": { "description": "This field specifies the email address to which the emails should be forwarded", "type": "string" } }, "type": "object" }, "type": "array" }, "mode": { "default": "verifyMailForward", "description": "This field specifies the mode in which the operation should be performed", "enum": [ "verifyMailForward" ], "type": "string" }, "zuid": { "description": "unique identifier of the user.", "format": "int64", "type": "integer" } }, "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.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ], "tags": [ "userManagement" ], "x-mcp-group": [ "User Management" ] } } }, "tags": [ { "name": "userManagement" } ] }