{ "openapi": "3.1.0", "info": { "description": "This is a Zoho Mail API OpenAPI 3.0 specification", "title": "Zoho Mail API", "version": "1.0.0" }, "tags": [ { "name": "account", "description": "The User Mail Account APIs help you to get and update information about the mail accounts and the related configurations and settings of the users in the organization. The following are part of Mail Accounts API", "externalDocs": { "url": "https://www.zoho.com/mail/help/api/account-api.html", "description": "Find out more" } }, { "name": "vacation", "description": "The User Vacation APIs help you to get and update information about the vacations and the related configurations and settings of the users in the organization.", "externalDocs": { "url": "https://www.zoho.com/mail/help/api/put-add-vacation-reply.html", "description": "Find out more" } } ], "paths": { "/api/accounts": { "get": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Get all accounts", "description": "This API is used to retrieve all the accounts details of the authenticated user.", "operationId": "getMailAccounts", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountsResponse" } } } }, "400": { "description": "Invalid input passed" }, "404": { "description": "Page not found" }, "500": { "description": "Internal Error" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL" ] } ] } }, "/api/accounts/{accountId}": { "get": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Get Specific Account Details", "description": "Retrieve details of a specific Zoho Mail account.", "operationId": "getAccountDetails", "parameters": [ { "name": "accountId", "in": "path", "description": "Unique identifier of the account.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountResponse" } } } }, "400": { "description": "Invalid input passed" }, "404": { "description": "Page not found" }, "500": { "description": "Internal Error" } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL" ] } ] } }, "/api/accounts/{accountIdToUpdateDisplayName}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Display Name of the User (Self)", "description": "This API is used by a user to update their own display name.", "operationId": "updateUserDisplayNameSelf", "parameters": [ { "name": "accountIdToUpdateDisplayName", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDisplayNameUserRequest" } } } }, "responses": { "200": { "description": "Successfully updated display name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToUpdateDisplayName}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Display Name of the User (Admin)", "description": "This API is used by an admin to update the display name of a user within the organization.", "operationId": "updateUserDisplayNameAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory while using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToUpdateDisplayName", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDisplayNameAdminRequest" } } } }, "responses": { "200": { "description": "Successfully updated display name", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToUpdateEmailAddress}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Email Address of the User (Admin)", "description": "This API is used by an admin to update the email address of a user within the organization.", "operationId": "updateUserEmailAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory only when using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToUpdateEmailAddress", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmailAdminRequest" } } } }, "responses": { "200": { "description": "Successfully updated email address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToUpdateEmailAddress}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Email Address of the User (Self)", "description": "This API is used by a user to update their own email address.", "operationId": "updateUserEmailSelf", "parameters": [ { "name": "accountIdToUpdateEmailAddress", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateEmailUserRequest" } } } }, "responses": { "200": { "description": "Successfully updated email address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToAddSendMailDetails}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Add Send Mail Details (Admin)", "description": "This API is used by an admin to add send mail details such as the display name and the email address of a user.", "operationId": "addSendMailDetailsAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory while using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToAddSendMailDetails", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSendMailDetailsAdminRequest" } } } }, "responses": { "200": { "description": "Successfully added send mail details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToAddSendMailDetails}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Add Send Mail Details (Self)", "description": "This API is used by a user to add their own send mail details such as the display name and the email address.", "operationId": "addSendMailDetailsSelf", "parameters": [ { "name": "accountIdToAddSendMailDetails", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddSendMailDetailsUserRequest" } } } }, "responses": { "200": { "description": "Successfully added send mail details", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToUpdateDisplayNameAndEmail}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Display Name and Email Address of the User (Admin)", "description": "This API is used by an admin to update the display name and email address of a user within the organization.", "operationId": "updateUserDisplayNameAndEmailAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory only when using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToUpdateDisplayNameAndEmail", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDisplayNameAndEmailAdminRequest" } } } }, "responses": { "200": { "description": "Successfully updated display name and email address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToUpdateDisplayNameAndEmail}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Display Name and Email Address of the User (Self)", "description": "This API is used by a user to update their own display name and email address.", "operationId": "updateUserDisplayNameAndEmailSelf", "parameters": [ { "name": "accountIdToUpdateDisplayNameAndEmail", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateDisplayNameAndEmailUserRequest" } } } }, "responses": { "200": { "description": "Successfully updated display name and email address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToUpdateMailSequence}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Mail Account Sequence of the User (Admin)", "description": "This API is used by an admin to modify the sequence of mail accounts associated with a user's account.", "operationId": "updateMailAccountSequenceAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory while using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToUpdateMailSequence", "in": "path", "description": "This parameter is used to identify the account whose details are to be retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMailAccountSequenceAdminRequest" } } } }, "responses": { "200": { "description": "Successfully updated mail account sequence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToUpdateMailSequence}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Mail Account Sequence of the User (Self)", "description": "This API is used by a user to modify the sequence of their mail accounts.", "operationId": "updateMailAccountSequenceSelf", "parameters": [ { "name": "accountIdToUpdateMailSequence", "in": "path", "description": "This parameter is used to identify the account whose details are to be retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateMailAccountSequenceUserRequest" } } } }, "responses": { "200": { "description": "Successfully updated mail account sequence", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToUpdateReplyTo}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Reply To Address (Admin)", "description": "This API is used by an admin to update the reply-to address of a user's account.", "operationId": "updateReplyToAddressAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory while using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToUpdateReplyTo", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReplyToAddressAdminRequest" } } } }, "responses": { "200": { "description": "Successfully updated reply-to address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToUpdateReplyTo}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Update Reply To Address (Self)", "description": "This API is used by a user to update their own reply-to address.", "operationId": "updateReplyToAddressSelf", "parameters": [ { "name": "accountIdToUpdateReplyTo", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateReplyToAddressUserRequest" } } } }, "responses": { "200": { "description": "Successfully updated reply-to address", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToResendReplyToVerification}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Resend Verification for Reply-To Address (Admin)", "description": "This API is used by an admin to resend the verification email for confirming the Reply-To address associated with a user's account.", "operationId": "resendVerificationReplyToAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory while using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToResendReplyToVerification", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendVerificationReplyToAdminRequest" } } } }, "responses": { "200": { "description": "Verification email successfully resent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToResendReplyToVerification}": { "put": { "tags": [ "account" ], "x-mcp-group": [ "Account" ], "summary": "Resend Verification for Reply-To Address (Self)", "description": "This API is used by a user to resend the verification email for their Reply-To address.", "operationId": "resendVerificationReplyToSelf", "parameters": [ { "name": "accountIdToResendReplyToVerification", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResendVerificationReplyToUserRequest" } } } }, "responses": { "200": { "description": "Verification email successfully resent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToAddVacation}": { "put": { "tags": [ "vacation" ], "x-mcp-group": [ "Vacation" ], "summary": "Add Vacation Reply for an Account (Admin)", "description": "This API is used by an admin to add a vacation reply to a user's account.", "operationId": "addVacationReplyAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory while using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToAddVacation", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddVacationReplyAdminRequest" } } } }, "responses": { "200": { "description": "Successfully added vacation reply", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToAddVacation}": { "put": { "tags": [ "vacation" ], "x-mcp-group": [ "Vacation" ], "summary": "Add Vacation Reply for an Account (Self)", "description": "This API is used by a user to add a vacation reply to their own account.", "operationId": "addVacationReplySelf", "parameters": [ { "name": "accountIdToAddVacation", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddVacationReplyUserRequest" } } } }, "responses": { "200": { "description": "Successfully added vacation reply", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToUpdateVacation}": { "put": { "tags": [ "vacation" ], "x-mcp-group": [ "Vacation" ], "summary": "Update Vacation Reply of an Account (Admin)", "description": "This API is used by an admin to update the vacation reply for a user's account.", "operationId": "updateVacationReplyAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory while using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToUpdateVacation", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVacationReplyAdminRequest" } } } }, "responses": { "200": { "description": "Successfully updated vacation reply", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToUpdateVacation}": { "put": { "tags": [ "vacation" ], "x-mcp-group": [ "Vacation" ], "summary": "Update Vacation Reply of an Account (Self)", "description": "This API is used by a user to update their own vacation reply.", "operationId": "updateVacationReplySelf", "parameters": [ { "name": "accountIdToUpdateVacation", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVacationReplyUserRequest" } } } }, "responses": { "200": { "description": "Successfully updated vacation reply", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } }, "/api/organization/{zoid}/accounts/{accountIdToRemoveVacation}": { "put": { "tags": [ "vacation" ], "x-mcp-group": [ "Vacation" ], "summary": "Remove Vacation Reply of an Account (Admin)", "description": "This API is used by an admin to remove/delete a vacation reply added to a user's account.", "operationId": "removeVacationReplyAdmin", "parameters": [ { "name": "zoid", "in": "path", "description": "This parameter denotes the unique Zoho Organization Identifier for the organization. This parameter is mandatory while using admin authentication.", "required": true, "schema": { "type": "string" } }, { "name": "accountIdToRemoveVacation", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveVacationReplyAdminRequest" } } } }, "responses": { "200": { "description": "Successfully removed vacation reply", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.organization.accounts.ALL", "ZohoMail.organization.accounts.UPDATE" ] } ] } }, "/api/accounts/{accountIdToRemoveVacation}": { "put": { "tags": [ "vacation" ], "x-mcp-group": [ "Vacation" ], "summary": "Remove Vacation Reply of an Account (Self)", "description": "This API is used by a user to remove/delete their own vacation reply.", "operationId": "removeVacationReplySelf", "parameters": [ { "name": "accountIdToRemoveVacation", "in": "path", "description": "This parameter is used to identify the account whose details are retrieved. This parameter can be retrieved from the Get User Account Details API.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveVacationReplyUserRequest" } } } }, "responses": { "200": { "description": "Successfully removed vacation reply", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NoDataResponse" } } } } }, "security": [ { "iam-oauth2-schema": [ "ZohoMail.accounts.ALL", "ZohoMail.accounts.UPDATE" ] } ] } } }, "components": { "schemas": { "Status": { "type": "object", "properties": { "code": { "type": "integer", "examples": [ 200 ] }, "description": { "type": "string", "examples": [ "success" ] } } }, "NoDataResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Status" } } }, "AccountsResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Status" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/Account" } } } }, "AccountResponse": { "type": "object", "properties": { "status": { "$ref": "#/components/schemas/Status" }, "data": { "$ref": "#/components/schemas/Account" } } }, "Account": { "type": "object", "properties": { "accountId": { "type": "string", "example": "2560636000000008002" }, "accountDisplayName": { "type": "string", "example": "Rebecca" }, "incomingUserName": { "type": "string", "example": "rebecca@zylker.com" }, "accountName": { "type": "string", "example": "bizdemo" }, "type": { "type": "string", "example": "ZOHO_ACCOUNT" }, "mailboxStatus": { "type": "string", "example": "enabled" }, "imapAccessEnabled": { "type": "boolean" }, "popAccessEnabled": { "type": "boolean" }, "smtpStatus": { "type": "boolean" }, "mailForward": { "type": "array", "items": { "$ref": "#/components/schemas/MailForward" } }, "emailAddress": { "type": "array", "items": { "$ref": "#/components/schemas/EmailAddress" } }, "vacationResponse": { "type": "array", "items": { "$ref": "#/components/schemas/VacationResponse" } }, "sendMailDetails": { "type": "array", "items": { "$ref": "#/components/schemas/SendMailDetails" } }, "address": { "$ref": "#/components/schemas/Address" }, "URI": { "type": "string", "format": "uri", "example": "https://mail.zoho.com/api/accounts/2560636000000008002" } } }, "MailForward": { "type": "object", "properties": { "mailForwardTo": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" } } }, "EmailAddress": { "type": "object", "properties": { "isAlias": { "type": "boolean" }, "isPrimary": { "type": "boolean" }, "mailId": { "type": "string" }, "isConfirmed": { "type": "boolean" } } }, "VacationResponse": { "type": "object", "properties": { "subject": { "type": "string" }, "fromDate": { "type": "string", "format": "date" }, "toDate": { "type": "string", "format": "date" }, "content": { "type": "string" }, "accountId": { "type": "string" }, "vacationId": { "type": "string" } } }, "SendMailDetails": { "type": "object", "properties": { "sendMailId": { "type": "string" }, "displayName": { "type": "string" }, "serverName": { "type": "string" }, "serverPort": { "type": "integer" }, "userName": { "type": "string" }, "connectionType": { "type": "string" }, "fromAddress": { "type": "string" }, "status": { "type": "boolean" } } }, "Address": { "type": "object", "properties": { "country": { "type": "string" }, "streetAddr": { "type": "string" }, "city": { "type": "string" }, "postalCode": { "type": "string" }, "state": { "type": "string" } } }, "UpdateDisplayNameAdminRequest": { "type": "object", "required": [ "zuid", "mode", "displayName" ], "properties": { "zuid": { "type": "string", "description": "This denotes the unique Zoho User Identifier for the user. This parameter is mandatory while using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "updateDisplayName" ], "example": "updateDisplayName" }, "displayName": { "type": "string", "description": "Specify the new display name to be updated." } } }, "UpdateDisplayNameUserRequest": { "type": "object", "required": [ "mode", "displayName" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "updateDisplayName" ], "example": "updateDisplayName" }, "displayName": { "type": "string", "description": "Specify the new display name to be updated." } } }, "UpdateEmailAdminRequest": { "type": "object", "required": [ "zuid", "mode", "emailAddress" ], "properties": { "zuid": { "type": "string", "description": "This denotes the unique Zoho User Identifier for the user. This parameter is mandatory only when using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "emailupdate" ], "example": "emailupdate" }, "emailAddress": { "type": "string", "format": "email", "description": "Specify the new email address to be updated." } } }, "UpdateEmailUserRequest": { "type": "object", "required": [ "mode", "emailAddress" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "emailupdate" ], "example": "emailupdate" }, "emailAddress": { "type": "string", "format": "email", "description": "Specify the new email address to be updated." } } }, "AddSendMailDetailsAdminRequest": { "type": "object", "required": [ "zuid", "mode", "sendMailDetails" ], "properties": { "zuid": { "type": "string", "description": "This denotes the unique Zoho User Identifier for the user. This parameter is mandatory while using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "addsendmaildetails" ], "example": "addsendmaildetails" }, "sendMailDetails": { "description": "This array of json objects contains the sendmaildetails info", "type": "array", "items": { "description": "This array of json objects contains the sendmaildetails info", "$ref": "#/components/schemas/SendMailDetailsPayload" } } } }, "AddSendMailDetailsUserRequest": { "type": "object", "required": [ "mode", "sendMailDetails" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "addsendmaildetails" ], "example": "addsendmaildetails" }, "sendMailDetails": { "description": "This array of json objects contains the sendmaildetails info", "type": "array", "items": { "description": "This array of json objects contains the sendmaildetails info", "$ref": "#/components/schemas/SendMailDetailsPayload" } } } }, "SendMailDetailsPayload": { "type": "object", "required": [ "displayName", "mode" ], "properties": { "fromAddress": { "type": "string", "format": "email", "description": "This parameter specifies the email address to be updated as the default email of the user." }, "displayName": { "type": "string", "description": "This parameter specifies the name that has to be updated has displayName for the given email address." }, "mode": { "type": "string", "description": "This parameter specifies the mode of the from email address added to the account.", "enum": [ "extmailbox", "extfrom" ] }, "serverName": { "type": "string", "description": "Specify the SMTP Server name, if the mode is set to extfrom, an external From address." }, "serverPort": { "type": "string", "description": "Specify the port number in which the SMTP server should be connected." }, "userName": { "type": "string", "description": "Specify the user name of the account which is set as the From Address, to connect to the SMTP server." }, "password": { "type": "string", "format": "password", "description": "Specify the password corresponding to the account used to connect to the SMTP Server." }, "smtpConnection": { "type": "string", "description": "Specifies the type of SMTP connection to attempt when connecting to the provided server." } } }, "UpdateDisplayNameAndEmailAdminRequest": { "type": "object", "required": [ "zuid", "mode", "displayName", "emailAddress" ], "properties": { "zuid": { "type": "string", "description": "This denotes the unique Zoho User Identifier for the user. This parameter is mandatory only when using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "displaynameemailupdate" ], "example": "displaynameemailupdate" }, "displayName": { "type": "string", "description": "Specify the new display name to be updated." }, "emailAddress": { "type": "string", "format": "email", "description": "Specify the new email address to be updated." } } }, "UpdateDisplayNameAndEmailUserRequest": { "type": "object", "required": [ "mode", "displayName", "emailAddress" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "displaynameemailupdate" ], "example": "displaynameemailupdate" }, "displayName": { "type": "string", "description": "Specify the new display name to be updated." }, "emailAddress": { "type": "string", "format": "email", "description": "Specify the new email address to be updated." } } }, "UpdateMailAccountSequenceAdminRequest": { "type": "object", "required": [ "zuid", "mode", "accList" ], "properties": { "zuid": { "type": "string", "description": "This denotes the unique Zoho User Identifier for the user. This parameter is mandatory while using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "mailaccountorderupdate" ], "example": "mailaccountorderupdate" }, "accList": { "type": "string", "description": "This parameter specifies the list of accountIds in the sequence in which they should be (comma-separated).", "pattern": "^\\d+(,\\d+)*$" } } }, "UpdateMailAccountSequenceUserRequest": { "type": "object", "required": [ "mode", "accList" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "mailaccountorderupdate" ], "example": "mailaccountorderupdate" }, "accList": { "type": "string", "description": "This parameter specifies the list of accountIds in the sequence in which they should be (comma-separated).", "pattern": "^\\d+(,\\d+)*$" } } }, "UpdateReplyToAddressAdminRequest": { "type": "object", "required": [ "zuid", "mode", "replyTo" ], "properties": { "zuid": { "type": "string", "description": "This denotes the unique Zoho User Identifier for the user. This parameter is mandatory while using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "updateReplyToStatus" ], "example": "updateReplyToStatus" }, "replyTo": { "type": "string", "format": "email", "description": "Specify the email address that needs to be updated as the new reply-to address." } } }, "UpdateReplyToAddressUserRequest": { "type": "object", "required": [ "mode", "replyTo" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "updateReplyToStatus" ], "example": "updateReplyToStatus" }, "replyTo": { "type": "string", "format": "email", "description": "Specify the email address that needs to be updated as the new reply-to address." } } }, "ResendVerificationReplyToAdminRequest": { "type": "object", "required": [ "zuid", "mode" ], "properties": { "zuid": { "type": "string", "description": "This denotes the unique Zoho User Identifier for the user. This parameter is mandatory while using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "resendVerificationMailForReplyTo" ], "example": "resendVerificationMailForReplyTo" } } }, "ResendVerificationReplyToUserRequest": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "resendVerificationMailForReplyTo" ], "example": "resendVerificationMailForReplyTo" } } }, "AddVacationReplyAdminRequest": { "type": "object", "required": [ "zuid", "mode", "vacationResponse" ], "properties": { "zuid": { "type": "string", "description": "This parameter denotes the unique Zoho User Identifier for the user. This parameter is mandatory while using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "addVacationReply" ], "example": "addVacationReply" }, "vacationResponse": { "description": "This JSON Object contains the vacation info", "$ref": "#/components/schemas/VacationResponsePayload" } } }, "AddVacationReplyUserRequest": { "type": "object", "required": [ "mode", "vacationResponse" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "addVacationReply" ], "example": "addVacationReply" }, "vacationResponse": { "description": "This JSON Object contains the vacation info", "$ref": "#/components/schemas/VacationResponsePayload" } } }, "VacationResponsePayload": { "type": "object", "required": [ "fromDate", "toDate" ], "properties": { "subject": { "type": "string", "description": "Specifies the subject of the vacation response email." }, "content": { "type": "string", "description": "Specifies the content of the vacation response email." }, "sendTo": { "type": "string", "description": "Specifies whether the vacation reply should be sent to all senders or only for emails from known contacts.", "enum": [ "all", "contacts", "noncontacts", "org", "nonOrgAll", "nonOrgContacts", "nonOrgNonContacts" ] }, "fromDate": { "type": "string", "format": "date-time", "description": "Specifies the date from which the vacation response should be sent. Format: MM/DD/YYYY HH:MM:SS", "pattern": "^(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])/\\d{4} (0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", "example": "12/11/2023 11:34:00" }, "toDate": { "type": "string", "format": "date-time", "description": "Specifies the date to which the vacation response should be sent. Format: MM/DD/YYYY HH:MM:SS", "pattern": "^(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])/\\d{4} (0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", "example": "20/11/2023 11:34:00" }, "forAllAccts": { "type": "boolean", "description": "Specifies whether the vacation response applies to all accounts or not. True - Applies to all accounts. False - Does not apply to all accounts." }, "sendingInt": { "type": "integer", "format": "int32", "description": "Specifies the sending interval of the vacation response email." }, "name": { "type": "string", "description": "Specifies a name for the vacation." }, "replyForAllMails": { "type": "boolean", "description": "Specifies whether vacation response emails should be sent to all mails or not. True - Send vacation reply to all mails. False - Do not send vacation reply to all mails." }, "replyForToMails": { "type": "boolean", "description": "Specifies whether vacation reply should be sent to mails only if the sender's email address is in the 'To' field. True - The vacation reply will only be sent to emails where the sender's email address appears in the 'To' field. False - The vacation reply will be sent to all incoming emails, regardless of whether the sender's email address is in the 'To' field." } } }, "UpdateVacationReplyAdminRequest": { "type": "object", "required": [ "zuid", "mode", "vacationResponse" ], "properties": { "zuid": { "type": "string", "description": "This parameter denotes the unique Zoho User Identifier for the user. This parameter is mandatory while using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "updateVacationReply" ], "example": "updateVacationReply" }, "vacationResponse": { "description": "This JSON Object contains the vacation info", "$ref": "#/components/schemas/VacationResponseUpdate" } } }, "UpdateVacationReplyUserRequest": { "type": "object", "required": [ "mode", "vacationResponse" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "updateVacationReply" ], "example": "updateVacationReply" }, "vacationResponse": { "description": "This JSON Object contains the vacation info", "$ref": "#/components/schemas/VacationResponseUpdate" } } }, "VacationResponseUpdate": { "type": "object", "required": [ "fromDate", "toDate" ], "properties": { "subject": { "type": "string", "description": "Specifies the subject of the vacation response email." }, "content": { "type": "string", "description": "Specifies the content of the vacation response email." }, "sendTo": { "type": "string", "description": "Specifies whether the vacation reply should be sent to all senders or only for emails from known contacts.", "enum": [ "all", "contacts", "noncontacts", "org", "nonOrgAll", "nonOrgContacts", "nonOrgNonContacts" ] }, "fromDate": { "type": "string", "format": "date-time", "description": "Specifies the date from which the vacation response should be sent. Format: MM/DD/YYYY HH:MM:SS", "pattern": "^(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])/\\d{4} (0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", "example": "12/11/2023 11:34:00" }, "toDate": { "type": "string", "format": "date-time", "description": "Specifies the date to which the vacation response should be sent. Format: MM/DD/YYYY HH:MM:SS", "pattern": "^(0[1-9]|1[0-2])/(0[1-9]|[1-2][0-9]|3[0-1])/\\d{4} (0[0-9]|1[0-9]|2[0-3]):([0-5][0-9]):([0-5][0-9])$", "example": "20/11/2023 11:34:00" }, "forAllAccts": { "type": "boolean", "description": "Specifies whether the vacation response applies to all accounts or not. True - Applies to all accounts. False - Does not apply to all accounts." }, "sendingInt": { "type": "integer", "format": "int32", "description": "Specifies the sending interval of the vacation response email." }, "replyForAllMails": { "type": "boolean", "description": "Specifies whether vacation response emails should be sent to all mails or not. True - Send vacation reply to all mails. False - Do not send vacation reply to all mails." }, "replyForToMails": { "type": "boolean", "description": "Specifies whether vacation reply should be sent to mails only if the sender's email address is in the 'To' field. True - The vacation reply will only be sent to emails where the sender's email address appears in the 'To' field. False - The vacation reply will be sent to all incoming emails, regardless of whether the sender's email address is in the 'To' field." }, "name": { "type": "string", "description": "Specifies a name for the vacation." }, "vacationId": { "type": "string", "description": "This parameter denotes the unique identifier for vacation response email." } } }, "RemoveVacationReplyAdminRequest": { "type": "object", "required": [ "zuid", "mode" ], "properties": { "zuid": { "type": "string", "description": "This parameter denotes the unique Zoho User Identifier for the user. This parameter is mandatory while using admin authentication." }, "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "deleteVacationReply" ], "example": "deleteVacationReply" } } }, "RemoveVacationReplyUserRequest": { "type": "object", "required": [ "mode" ], "properties": { "mode": { "type": "string", "description": "This parameter represents the type of operation that is to be performed.", "enum": [ "deleteVacationReply" ], "example": "deleteVacationReply" } } } }, "securitySchemes": { "iam-oauth2-schema": { "type": "oauth2", "flows": { "authorizationCode": { "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "tokenUrl": "https://accounts.zoho.com/oauth/v2/token", "scopes": { "ZohoMail.accounts.ALL": "Full access to accounts", "ZohoMail.accounts.UPDATE": "Update access to accounts", "ZohoMail.organization.accounts.ALL": "Full access to organization accounts", "ZohoMail.organization.accounts.UPDATE": "Update access to organization accounts" } } } } } } }