{ "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.subscriptions.ALL": "Full access to subscription", "ZohoMail.organization.subscriptions.READ": "Read access to subscription", "ZohoMail.organization.subscriptions.UPDATE": "update access to subscription", "ZohoMail.partner.organization.ALL": "Full access to partner organization", "ZohoMail.partner.organization.CREATE": "Write access to partner organization", "ZohoMail.partner.organization.DELETE": "delete access to partner organization", "ZohoMail.partner.organization.READ": "Read access to partner organization" }, "tokenUrl": "https://accounts.zoho.com/oauth/v2/token" } }, "type": "oauth2" } } }, "info": { "title": "Zohomail cli", "version": "1.0" }, "openapi": "3.0.1", "paths": { "/api/organization": { "description": "To create a new child organization, along with the domain and other details, and associates it with the partner portal", "post": { "operationId": "addChildOrg", "parameters": [], "requestBody": { "content": { "application/json": { "example": { "domainName": "zylker-mail.com", "emailId": "zylkermail@zylker-mail.com", "firstName": "zylkermail", "lastName": "Z", "orgName": "zylkermail", "password": "zylkermail@0" }, "schema": { "properties": { "domainName": { "description": "This field specifies the domain name of the organization", "type": "string" }, "emailId": { "description": "This field specifies the email ID of the superadmin of the org", "type": "string" }, "firstName": { "description": "This field specifies the first name of the superadmin of the org", "type": "string" }, "lastName": { "description": "This field specifies the last name of the superadmin of the org", "type": "string" }, "orgName": { "description": "This field specifies the name of the organization", "type": "string" }, "password": { "description": "This field specifies the password of the superadmin of the org", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "URI": { "description": "This field specifies the URI of the organization", "type": "string" }, "basePlan": { "description": "This field specifies the base subscription plan of the organization", "type": "string" }, "domainName": { "description": "This field specifies the domain name of the organization", "type": "string" }, "encryptedZoid": { "description": "This field specifies the encrypted unique identifier of the organization", "type": "string" }, "isEmailConfirmed": { "description": "This field specifies whether the email is confirmed for the organization or not", "type": "boolean" }, "isOrgLogoExist": { "description": "This field specifies whether the organization logo exists or not", "type": "boolean" }, "isTrialAllowed": { "description": "This field specifies whether a trial is allowed for the organization or not", "type": "boolean" }, "isVerified": { "description": "This field specifies whether the domain is verified or not", "type": "boolean" }, "licenseCount": { "description": "This field specifies the number of licenses available for the organization", "format": "int32", "type": "integer" }, "orgName": { "description": "This field specifies the name of the organization", "type": "string" }, "st_enc_zoid": { "description": "This field specifies the encrypted zoid of the org", "type": "string" }, "superAdmin": { "description": "This field specifies the super admin of the organization", "type": "string" }, "usedLicenseCount": { "description": "This field specifies the number of licenses used in the organization", "format": "int32", "type": "integer" }, "zaid": { "description": "This field specifies the unique identifier of the appacount in organization", "type": "string" }, "zoid": { "description": "unique identifier of the organization.", "type": "string" } }, "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.partner.organization.ALL", "ZohoMail.partner.organization.CREATE" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] } }, "/api/organization/{addAllowedIPZoid}/allowedIps": { "description": "To add an Allowed IP range for your organization and assign them to the users based on their role or the entire organization", "post": { "operationId": "addAllowedIP", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addAllowedIPZoid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "allowedIps": [ { "fromIpRange": "0.0.0.0", "roleId": 0, "toIpRange": "255.255.255.255" } ] }, "schema": { "properties": { "allowedIps": { "description": "This field specifies the allowed IPs for the user to login", "items": { "properties": { "fromIpRange": { "description": "This field specifies the range of IP addresses from which the user is allowed to login", "type": "string" }, "roleId": { "description": "This field specifies the role ID of the user/admin,0 for user,1 for admins,2 for super admin,-1 for all", "enum": [ 0, 1, 2, -1 ], "format": "int32", "type": "integer" }, "toIpRange": { "description": "This field specifies the range of IP addresses to which the user is allowed to login", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "allowedIps": { "description": "This field specifies the allowed IPs for the user to login", "items": { "properties": { "ip": { "description": "This field specifies the IP address of the user to login", "items": { "properties": { "isipinRange": { "description": "This field specifies whether the IP address is within the allowed range or not", "type": "string" }, "user": { "items": { "properties": { "fromip": { "description": "This field specifies the IP address from which the user is allowed to login", "type": "string" }, "ipid": { "description": "This field specifies the IP address of the user", "format": "int32", "type": "integer" }, "toip": { "description": "This field specifies the IP address to which the user is allowed to login", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "type": "array" }, "failedList": { "description": "This field specifies the list of failed Allowed IPs", "items": { "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.accounts.ALL", "ZohoMail.organization.accounts.CREATE" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] } }, "/api/organization/{deleteAllowedIPZoid}/allowedIps": { "delete": { "operationId": "deleteAllowedIP", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteAllowedIPZoid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "allowedIps": [ { "fromIp": "0.0.0.0", "ipId": 799551071, "roleId": 0, "toIp": "255.255.255.255" } ] }, "schema": { "properties": { "allowedIps": { "description": "This field specifies the allowed IPs for the user to login", "items": { "properties": { "fromIp": { "description": "This field specifies the IP address from which the user is allowed to login", "type": "string" }, "ipId": { "description": "This field specifies the unique identifier of the IP address", "format": "int32", "type": "integer" }, "roleId": { "description": "This field specifies the role ID of the user/admin,0 for user,1 for admins,2 for super admin,-1 for all", "enum": [ 0, 1, 2, -1 ], "format": "int32", "type": "integer" }, "toIp": { "description": "This field specifies the IP address to which the user is allowed to login", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "allowedIps": { "description": "This field specifies the allowed IPs for the user to login", "items": { "properties": { "fromIpRange": { "description": "This field specifies the range of IP addresses from which the user is allowed to login", "type": "string" }, "ipId": { "description": "This field specifies the unique identifier of the IP address", "format": "int32", "type": "integer" }, "roleId": { "description": "This field specifies the role ID of the user/admin,0 for user,1 for admins,2 for super admin,-1 for all", "format": "int32", "type": "integer" }, "toIpRange": { "description": "This field specifies the range of IP addresses to which the user is allowed to login", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } } }, "description": "Success" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.partner.organization.ALL", "ZohoMail.partner.organization.DELETE" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] }, "description": "To delete an Allowed IP range for your organization." }, "/api/organization/{getAllowedIPZoid}/allowedIps": { "description": "To fetch the list of allowed IP ranges for your organization.", "get": { "operationId": "getAllowedIP", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "getAllowedIPZoid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "allowedIps": { "description": "This field specifies the allowed IPs for the user to login", "items": { "properties": { "ip": { "description": "This field specifies the IP address of the user to login", "items": { "anyOf": [ { "properties": { "isipinRange": { "description": "This field specifies whether the IP address is within the allowed range or not", "type": "string" }, "user": { "items": { "properties": { "fromip": { "description": "This field specifies the IP address from which the user is allowed to login", "type": "string" }, "ipid": { "description": "This field specifies the IP address of the user", "format": "int32", "type": "integer" }, "toip": { "description": "This field specifies the IP address to which the user is allowed to login", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, { "properties": { "admin": { "items": { "properties": { "fromip": { "description": "This field specifies the IP address from which the user is allowed to login", "type": "string" }, "ipid": { "description": "This field specifies the IP address of the user", "format": "int32", "type": "integer" }, "toip": { "description": "This field specifies the IP address to which the user is allowed to login", "type": "string" } }, "type": "object" }, "type": "array" }, "isipinRange": { "description": "This field specifies whether the IP address is within the allowed range or not", "type": "string" } }, "type": "object" }, { "properties": { "all": { "items": { "properties": { "fromip": { "description": "This field specifies the IP address from which the user is allowed to login", "type": "string" }, "ipid": { "description": "This field specifies the IP address of the user", "format": "int32", "type": "integer" }, "toip": { "description": "This field specifies the IP address to which the user is allowed to login", "type": "string" } }, "type": "object" }, "type": "array" }, "isipinRange": { "description": "This field specifies whether the IP address is within the allowed range or not", "type": "string" } }, "type": "object" }, { "properties": { "isipinRange": { "description": "This field specifies whether the IP address is within the allowed range or not", "type": "string" }, "superadmin": { "items": { "properties": { "fromip": { "description": "This field specifies the IP address from which the user is allowed to login", "type": "string" }, "ipid": { "description": "This field specifies the IP address of the user", "format": "int32", "type": "integer" }, "toip": { "description": "This field specifies the IP address to which the user is allowed to login", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } ] }, "type": "array" } }, "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.partner.organization.ALL", "ZohoMail.partner.organization.READ" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] } }, "/api/organization/{getOrgDetailsZoid}": { "description": "To retrieve the details of the child organization.", "get": { "operationId": "getOrgDetails", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "getOrgDetailsZoid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "URI": { "description": "This field specifies the URI of the organization", "type": "string" }, "basePlan": { "description": "This field specifies the base subscription plan of the organization", "type": "string" }, "domains": { "description": "This field specifies the list of domains associated with the organization", "items": { "type": "string" }, "type": "array" }, "encryptedZoid": { "description": "This field specifies the encrypted unique identifier of the organization", "type": "string" }, "groupCount": { "description": "This field specifies the number of groups in the organization", "format": "int32", "type": "integer" }, "isDomainMarkingExist": { "description": "This field specifies whether domain marking exists for the organization or not", "type": "boolean" }, "isEmailConfirmed": { "description": "This field specifies whether the email is confirmed for the organization or not", "type": "boolean" }, "isMailHostingEnabled": { "description": "This field specifies whether mail hosting is enabled for the organization or not", "type": "boolean" }, "isOfferAvailable": { "description": "This field specifies whether an offer is available for the organization or not", "type": "boolean" }, "licenseCount": { "description": "This field specifies the number of licenses available for the organization", "format": "int32", "type": "integer" }, "mailboxCount": { "description": "This field specifies the number of mailboxes in the organization", "format": "int32", "type": "integer" }, "orgCreationTime": { "description": "This field specifies the creation time of the organization", "format": "int64", "type": "integer" }, "orgImageUrl": { "description": "This field specifies the URL of the organization image", "type": "string" }, "orgName": { "description": "This field specifies the name of the organization", "type": "string" }, "orgPolicyDetails": { "properties": { "1003505000081813009": { "type": "string" } }, "type": "object" }, "partnerOrgCount": { "description": "This field specifies the number of partner organizations associated with the organization", "format": "int32", "type": "integer" }, "planType": { "description": "This field specifies the type of subscription plan for the organization", "type": "string" }, "primaryDomainName": { "description": "This field specifies the primary domain name of the organization", "type": "string" }, "sharedGroupCount": { "description": "This field specifies the number of shared groups in the organization", "format": "int32", "type": "integer" }, "spamVO": { "properties": { "spamProcessType": { "type": "string" } }, "type": "object" }, "superAdmin": { "description": "This field specifies the super admin of the organization", "type": "string" }, "superAdminFullName": { "description": "This field specifies the full name of the super admin", "type": "string" }, "superAdminLoginName": { "description": "This field specifies the login name of the super admin", "type": "string" }, "usersCount": { "description": "This field specifies the number of users in the organization", "format": "int32", "type": "integer" }, "zaid": { "description": "This field specifies the unique identifier of the appacount in organization", "type": "string" }, "zoid": { "description": "unique identifier of the organization.", "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.partner.organization.ALL", "ZohoMail.partner.organization.READ" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] } }, "/api/organization/{getOrgSubscriptionZoid}/storage": { "description": "To retrieve the subscription details along with the storage information", "get": { "operationId": "getOrgSubscription", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "getOrgSubscriptionZoid", "required": true, "schema": { "type": "string" } }, { "description": "start of pagination for subsription Listing", "in": "query", "name": "start", "required": false, "schema": { "type": "string" } }, { "description": "limit of users number of subsription Listing", "in": "query", "name": "limit", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "userList": { "description": "This field specifies the list of users in the organization", "items": { "properties": { "basicStorage": { "description": "This field specifies the basic storage subscription plan available for the user", "type": "string" }, "mailBox": { "description": "This field specifies the mailbox details of the organization whether enabled or disabled", "type": "boolean" }, "totalStorage": { "description": "This field specifies the total storage available for the organization", "format": "int32", "type": "integer" }, "usedStorage": { "description": "This field specifies the used storage by the user", "format": "int32", "type": "integer" }, "zuid": { "description": "unique identifier of the user.", "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.subscriptions.ALL", "ZohoMail.organization.subscriptions.READ" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] } }, "/api/organization/{getOrgUserSubscriptionZoid}/storage/{zuid}": { "description": "The API retrieves the details of the available and allotted storage information for the particular user in the given Organization", "get": { "operationId": "getOrgUserSubscription", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "getOrgUserSubscriptionZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of organization", "in": "path", "name": "zuid", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "basicStorage": { "description": "This field specifies the basic storage subscription plan available for the user", "type": "string" }, "extraStorage": { "properties": { "5 gb": { "format": "int32", "type": "integer" } }, "type": "object" }, "mailBox": { "description": "This field specifies the mailbox details of the organization whether enabled or disabled", "type": "boolean" }, "totalStorage": { "description": "This field specifies the total storage available for the organization", "format": "int32", "type": "integer" }, "usedStorage": { "description": "This field specifies the used storage by the user", "format": "int32", "type": "integer" }, "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.subscriptions.ALL", "ZohoMail.organization.subscriptions.READ" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] } }, "/api/organization/{updateBaseStorageZoid}/storage/{zuid}": { "description": "The API updates the base storage for the particular user in the given organization", "put": { "operationId": "updateBaseStorage", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateBaseStorageZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of organization", "in": "path", "name": "zuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "updateBaseStorage", "planType": "mailPremium" }, "schema": { "properties": { "mode": { "default": "updateBaseStorage", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "updateBaseStorage" ], "type": "string" }, "planType": { "description": "This field specifies the type of subscription plan for the organization", "enum": [ "free", "ent", "pro", "std", "stdtrial", "basic", "professional", "basicTrial", "professionalTrial", "newMail1gb", "newMail5gb", "newMail10gb", "mailPremium", "mailPremiumTrial", "mailEssential", "familyLite", "familyStd", "familyPremium", "familyLiteTrial", "familyStdTrial", "familyPremiumTrial", "psg", "zohoOneStdTrial", "zohoOneStd", "zohoOneEntTrial", "zohoOneEnt", "mailKalvi", "mailKalviTrial", "unlicensed", "cnnewMail5gb", "cnnewMail10gb", "cnbasic", "cnprofessional", "cnmailPremium" ], "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.subscriptions.ALL", "ZohoMail.organization.subscriptions.UPDATE" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] } }, "/api/organization/{updateExtraStorageZoid}/storage/{zuid}": { "description": "The API updates the extra storage for the particular user in the given organization", "put": { "operationId": "updateExtraStorage", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "updateExtraStorageZoid", "required": true, "schema": { "type": "string" } }, { "description": "unique identifier of organization", "in": "path", "name": "zuid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "addonType": [ "25gb:1", "5gb:2" ], "mode": "updateExtraStorage" }, "schema": { "properties": { "addonType": { "description": "This field specifies the type of addon available for the user", "items": { "description": "This is an array of String, refer parent description for more details", "type": "string" }, "type": "array" }, "mode": { "default": "updateExtraStorage", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "updateExtraStorage" ], "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.subscriptions.ALL", "ZohoMail.organization.subscriptions.UPDATE" ] } ], "tags": [ "orgManagement" ], "x-mcp-group": [ "Org Management" ] } } }, "tags": [ { "name": "orgManagement" } ] }