{ "components": { "securitySchemes": { "iam-oauth2-schema": { "flows": { "authorizationCode": { "authorizationUrl": "https://accounts.zoho.com/oauth/v2/auth", "scopes": { "ZohoMail.organization.domains.ALL": "Full access to Organization domains", "ZohoMail.organization.domains.CREATE": "Write access to Organization domains", "ZohoMail.organization.domains.DELETE": "delete access to Organization domains", "ZohoMail.organization.domains.READ": "Read access to Organization domains", "ZohoMail.organization.domains.UPDATE": "update access to Organization domains" }, "tokenUrl": "https://accounts.zoho.com/oauth/v2/token" } }, "type": "oauth2" } } }, "info": { "title": "Zohomail cli", "version": "1.0" }, "openapi": "3.0.1", "paths": { "/api/organization/{VerifySpfRecordZoid}/domains/{domainName}": { "description": "This API is used to verify SPF record of your domain", "put": { "operationId": "VerifySpfRecord", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "VerifySpfRecordZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "VerifySpfRecord" }, "schema": { "properties": { "mode": { "default": "VerifySpfRecord", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "VerifySpfRecord" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "spfstatus": { "description": "This parameter specifies the SPF status of the domain.", "type": "boolean" } }, "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{addCatchAllAddressZoid}/domains/{domainName}": { "description": "This API is used to designate an email address as the catch-all account for your organization.", "put": { "operationId": "addCatchAllAddress", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addCatchAllAddressZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "catchAllAddress": "catchall@zylkernew.com", "mode": "addCatchAllAddress" }, "schema": { "properties": { "catchAllAddress": { "description": "A catch-all email account is a user mailbox or group mailbox that captures emails sent to any invalid email addresses of the domain", "type": "string" }, "mode": { "default": "addCatchAllAddress", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "addCatchAllAddress" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{addDkimDetailZoid}/domains/{domainName}": { "description": "This API is used to configure DKIM details for a particular domain added to Zoho Mail", "put": { "operationId": "addDkimDetail", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addDkimDetailZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "isDefault": true, "keySize": 1024, "mode": "addDkimDetail", "selector": "zmail" }, "schema": { "properties": { "isDefault": { "description": "This parameter specifies whether this DKIM details added needs to be set as the default or not.", "type": "boolean" }, "keySize": { "description": "This parameter specifies the key size of the DKIM record", "format": "int32", "type": "integer" }, "mode": { "default": "addDkimDetail", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "addDkimDetail" ], "type": "string" }, "selector": { "description": "This parameter is an attribute for the DKIM Signature.", "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "dkimId": { "description": "This parameter specifies the unique identifier of the DKIM record.", "type": "string" }, "domainId": { "description": "This parameter specifies the unique identifier of the domain.", "type": "string" }, "hashType": { "description": "This parameter hashing algorithm used to derive a fingerprint of a public key", "type": "string" }, "isDefault": { "description": "This parameter specifies whether this DKIM details added needs to be set as the default or not.", "type": "boolean" }, "isVerified": { "description": "This parameter specifies whether the domain record is verified or not.", "type": "boolean" }, "publicKey": { "type": "string" }, "selector": { "description": "This parameter is an attribute for the DKIM Signature.", "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.organization.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{addDomainZoid}/domains": { "description": "The API adds the specified domain to the given organization.", "post": { "operationId": "addDomain", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addDomainZoid", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "domainName": "zylkernew.com" }, "schema": { "properties": { "domainName": { "description": "This parameter specifies the name of the domain.", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "CNAMEVerificationCode": { "description": "This parameter specifies the CNAME verification code that needs to be added to the DNS records for domain verification.", "type": "string" }, "HTMLVerificationCode": { "description": "This parameter specifies the HTML verification code that needs to be added to the website for domain verification.", "type": "string" }, "createdTime": { "description": "This parameter specifies the time when the domain was created.", "format": "int64", "type": "integer" }, "domainName": { "description": "This parameter specifies the name of the domain.", "type": "string" }, "isRegisteredByZoho": { "description": "This parameter specifies whether the domain is registered by Zoho or not.", "type": "boolean" }, "primary": { "description": "This parameter specifies whether the domain is the primary domain or not.", "type": "boolean" }, "verificationStatus": { "description": "This parameter specifies the verification status of the domain.", "type": "boolean" } }, "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.domains.ALL", "ZohoMail.organization.domains.CREATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{addNotificationAddressZoid}/domains/{domainName}": { "description": "This API is used to designate an email address as the notification address for your organization.", "put": { "operationId": "addNotificationAddress", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "addNotificationAddressZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "addNotificationAddress", "notificationAddress": "notifications@zylker.com" }, "schema": { "properties": { "mode": { "default": "addNotificationAddress", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "addNotificationAddress" ], "type": "string" }, "notificationAddress": { "description": "This parameter specifies the email address to which notifications will be sent for the domain.", "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{deleteCatchAllAddressZoid}/domains/{domainName}": { "description": "This API is used to delete the catch-all address of your domain.", "put": { "operationId": "deleteCatchAllAddress", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteCatchAllAddressZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "deleteCatchAllAddress" }, "schema": { "properties": { "mode": { "default": "deleteCatchAllAddress", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "deleteCatchAllAddress" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{deleteDkimDetailZoid}/domains/{domainName}": { "description": "This API is used to delete an existing DKIM detail for a particular domain.", "put": { "operationId": "deleteDkimDetail", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteDkimDetailZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "dkimId": "100000500000888000", "mode": "deleteDkimDetail" }, "schema": { "properties": { "dkimId": { "description": "This parameter specifies the unique identifier of the DKIM record.", "type": "string" }, "mode": { "default": "deleteDkimDetail", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "deleteDkimDetail" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{deleteDomainZoid}/domains/{domainName}": { "delete": { "operationId": "deleteDomain", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteDomainZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "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.domains.ALL", "ZohoMail.organization.domains.DELETE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] }, "description": "The API removes the specified domain from the organization." }, "/api/organization/{deleteNotificationAddressZoid}/domains/{domainName}": { "description": "This API is used to delete the designated notification address of your domain.", "put": { "operationId": "deleteNotificationAddress", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "deleteNotificationAddressZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "deleteNotificationAddress" }, "schema": { "properties": { "mode": { "default": "deleteNotificationAddress", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "deleteNotificationAddress" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{disableSubDomainStrippingZoid}/domains/{domainName}": { "description": "This API is used to disable sub-domain stripping for your domain.", "put": { "operationId": "disableSubDomainStripping", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "disableSubDomainStrippingZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "disableSubDomainStripping" }, "schema": { "properties": { "mode": { "default": "disableSubDomainStripping", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "disableSubDomainStripping" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{enableMailHostingZoid}/domains/{domainName}": { "description": "The API enables the email hosting for the specified domain.", "put": { "operationId": "enableMailHosting", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "enableMailHostingZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "enableMailHosting" }, "schema": { "properties": { "mode": { "default": "enableMailHosting", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "enableMailHosting" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{enableSubDomainStrippingZoid}/domains/{domainName}": { "description": "This API is used to enable sub-domain stripping for your domain.", "put": { "operationId": "enableSubDomainStripping", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "enableSubDomainStrippingZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "enableSubDomainStripping" }, "schema": { "properties": { "mode": { "default": "enableSubDomainStripping", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "enableSubDomainStripping" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{fetchAllDomainsZoid}/domains": { "description": "The API fetches a list of all the domains added to the specified organization", "get": { "operationId": "fetchAllDomains", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "fetchAllDomainsZoid", "required": true, "schema": { "type": "string" } }, { "description": "Mode of fetching domains", "in": "query", "name": "mode", "required": true, "schema": { "default": "getDomainDetails", "type": "string" } }, { "description": "hosting status requirement", "in": "query", "name": "includeHostingStatus", "required": true, "schema": { "default": "true", "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "agreementUrl": { "type": "string" }, "allowedTlds": { "items": { "type": "string" }, "type": "array" }, "domainEnabled": { "type": "boolean" }, "domains": { "items": { "properties": { "dkim": { "type": "boolean" }, "domainName": { "description": "This parameter specifies the name of the domain.", "type": "string" }, "isExpired": { "description": "This parameter specifies whether the domain is expired or not.", "type": "boolean" }, "isPrimaryDomain": { "type": "boolean" }, "isRegisteredByZoho": { "description": "This parameter specifies whether the domain is registered by Zoho or not.", "type": "boolean" }, "isShowSiteBanner": { "type": "boolean" }, "isVerified": { "description": "This parameter specifies whether the domain record is verified or not.", "type": "boolean" }, "mh": { "type": "boolean" }, "spf": { "type": "boolean" } }, "type": "object" }, "type": "array" }, "hasActiveBuyDomains": { "type": "boolean" }, "hasVerifiedDomains": { "type": "boolean" }, "isMXEnabled": { "type": "boolean" }, "tldsWithRegistrant": { "properties": { "club": { "type": "string" }, "com": { "type": "string" }, "info": { "type": "string" }, "net": { "type": "string" }, "online": { "type": "string" }, "org": { "type": "string" }, "site": { "type": "string" }, "store": { "type": "string" }, "tech": { "type": "string" }, "website": { "type": "string" } }, "type": "object" }, "verificationPendingDomain": { "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.organization.domains.ALL", "ZohoMail.organization.domains.READ" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{fetchSpecificDomainZoid}/domains/{domainName}": { "description": "The API fetches the detailed information about a particular domain in the specified organization.", "get": { "operationId": "fetchSpecificDomain", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "fetchSpecificDomainZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "CNAMEVerificationCode": { "description": "This parameter specifies the CNAME verification code that needs to be added to the DNS records for domain verification.", "type": "string" }, "HTMLVerificationCode": { "description": "This parameter specifies the HTML verification code that needs to be added to the website for domain verification.", "type": "string" }, "URI": { "description": "This parameter specifies the URI of the domain.", "type": "string" }, "catchAllExcludeAddresses": { "description": "This parameter specifies the email address that are excluded from catch-all address", "items": { "type": "string" }, "type": "array" }, "createdTime": { "description": "This parameter specifies the time when the domain was created.", "format": "int64", "type": "integer" }, "dkimDetailList": { "description": "This parameter specifies the list of DKIM details associated with the domain.", "items": { "properties": { "dkimId": { "description": "This parameter specifies the unique identifier of the DKIM record.", "type": "string" }, "domainId": { "description": "This parameter specifies the unique identifier of the domain.", "type": "string" }, "hashType": { "description": "This parameter hashing algorithm used to derive a fingerprint of a public key", "type": "string" }, "isDefault": { "description": "This parameter specifies whether this DKIM details added needs to be set as the default or not.", "type": "boolean" }, "isVerified": { "description": "This parameter specifies whether the domain record is verified or not.", "type": "boolean" }, "publicKey": { "type": "string" }, "selector": { "description": "This parameter is an attribute for the DKIM Signature.", "type": "string" } }, "type": "object" }, "type": "array" }, "dkimstatus": { "description": "This parameter specifies the DKIM status of the domain.", "type": "boolean" }, "domainId": { "description": "This parameter specifies the unique identifier of the domain.", "type": "string" }, "domainName": { "description": "This parameter specifies the name of the domain.", "type": "string" }, "firstName": { "description": "This parameter specifies the first name of the user who verified the domain.", "type": "string" }, "isDomainAlias": { "description": "This parameter specifies whether the domain is a domain alias or not.", "type": "boolean" }, "isExpired": { "description": "This parameter specifies whether the domain is expired or not.", "type": "boolean" }, "isRegisteredByZoho": { "description": "This parameter specifies whether the domain is registered by Zoho or not.", "type": "boolean" }, "lastName": { "description": "This parameter specifies the last name of the user who verified the domain.", "type": "string" }, "mailHostingEnabled": { "description": "This parameter specifies whether the mail hosting is enabled for the domain or not.", "type": "boolean" }, "mxstatus": { "description": "This parameter specifies the MX status of the domain.", "type": "string" }, "primary": { "description": "This parameter specifies whether the domain is the primary domain or not.", "type": "boolean" }, "spfstatus": { "description": "This parameter specifies the SPF status of the domain.", "type": "boolean" }, "subDomainStripping": { "description": "This parameter specifies whether sub-domain stripping is enabled or not.", "format": "int32", "type": "integer" }, "verificationStatus": { "description": "This parameter specifies the verification status of the domain.", "type": "boolean" }, "verifiedBy": { "description": "This parameter specifies the zuid of the user who verified the domain.", "format": "int32", "type": "integer" }, "verifiedByAddress": { "description": "This parameter specifies the email address that is used to verify the domain.", "type": "string" }, "verifiedDate": { "description": "This parameter specifies the date when the domain was verified.", "format": "int64", "type": "integer" }, "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.organization.domains.ALL", "ZohoMail.organization.domains.READ" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{makeDkimDefaultZoid}/domains/{domainName}": { "description": "This API is used to set a default DKIM signature for your domain.", "put": { "operationId": "makeDkimDefault", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "makeDkimDefaultZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "dkimId": "100000500000888000", "mode": "makeDkimDefault" }, "schema": { "properties": { "dkimId": { "description": "This parameter specifies the unique identifier of the DKIM record.", "type": "string" }, "mode": { "default": "makeDkimDefault", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "makeDkimDefault" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{makeDomainAsAliasZoid}/domains/{domainName}": { "description": "The API adds the specified domain as an alias to another domain", "put": { "operationId": "makeDomainAsAlias", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "makeDomainAsAliasZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "domainAlias": "zylkertraining.com", "mode": "makeDomainAsAlias" }, "schema": { "properties": { "domainAlias": { "description": "This parameter specifies the domain alias for the domain.", "type": "string" }, "mode": { "default": "makeDomainAsAlias", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "makeDomainAsAlias" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{removeDomainAsAliasZoid}/domains/{domainName}": { "description": "The API removes the existing domain alias and disassociates the domain from the other domain", "put": { "operationId": "removeDomainAsAlias", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "removeDomainAsAliasZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "domainAlias": "zylkertraining.com", "mode": "removeDomainAsAlias" }, "schema": { "properties": { "domainAlias": { "description": "This parameter specifies the domain alias for the domain.", "type": "string" }, "mode": { "default": "removeDomainAlias", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "removeDomainAlias" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{setPrimaryDomainZoid}/domains/{domainName}": { "description": "The API sets the domain provided as the primary domain of the organization", "put": { "operationId": "setPrimaryDomain", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "setPrimaryDomainZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "setPrimaryDomain" }, "schema": { "properties": { "mode": { "default": "setPrimaryDomain", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "setPrimaryDomain" ], "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{verifyDkimKeyZoid}/domains/{domainName}": { "description": "This API is used to verify a DKIM public key of a particular domain.", "put": { "operationId": "verifyDkimKey", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "verifyDkimKeyZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "dkimId": "100000500000888000", "mode": "verifyDkimKey" }, "schema": { "properties": { "dkimId": { "description": "This parameter specifies the unique identifier of the DKIM record.", "type": "string" }, "mode": { "default": "verifyDkimKey", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "verifyDkimKey" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "dkimstatus": { "description": "This parameter specifies the DKIM status of the domain.", "type": "boolean" } }, "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{verifyDomainByCNameZoid}/domains/{domainName}": { "description": "The API tries to verify the domain added to the organization", "put": { "operationId": "verifyDomainByCName", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "verifyDomainByCNameZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "verifyDomainByCName" }, "schema": { "properties": { "mode": { "default": "verifyDomainByCName", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "verifyDomainByCName" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "status": { "description": "Represents the overall status of the REST API operation.", "type": "boolean" } }, "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{verifyDomainByHTMLZoid}/domains/{domainName}": { "description": "The API tries to verify the domain added to the organization", "put": { "operationId": "verifyDomainByHTML", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "verifyDomainByHTMLZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "verifyDomainByHTML" }, "schema": { "properties": { "mode": { "default": "verifyDomainByHTML", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "verifyDomainByHTML" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "status": { "description": "Represents the overall status of the REST API operation.", "type": "boolean" } }, "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{verifyDomainByTXTZoid}/domains/{domainName}": { "description": "The API tries to verify the domain added to the organization", "put": { "operationId": "verifyDomainByTXT", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "verifyDomainByTXTZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "verifyDomainByTXT" }, "schema": { "properties": { "mode": { "default": "verifyDomainByTXT", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "verifyDomainByTXT" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "status": { "description": "Represents the overall status of the REST API operation.", "type": "boolean" } }, "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } }, "/api/organization/{verifyMxRecordZoid}/domains/{domainName}": { "description": "This API is used to verify MX record of your domain", "put": { "operationId": "verifyMxRecord", "parameters": [ { "description": "unique identifier of organization", "in": "path", "name": "verifyMxRecordZoid", "required": true, "schema": { "type": "string" } }, { "description": "Name of the domain", "in": "path", "name": "domainName", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "example": { "mode": "verifyMxRecord" }, "schema": { "properties": { "mode": { "default": "verifyMxRecord", "description": "Specifies the mode in which the operation should be performed.", "enum": [ "verifyMxRecord" ], "type": "string" } }, "required": [ "mode" ], "type": "object" } } } }, "responses": { "200": { "content": { "application/json": { "schema": { "properties": { "data": { "properties": { "mxstatus": { "description": "This parameter specifies the MX status of the domain.", "type": "boolean" } }, "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.domains.ALL", "ZohoMail.organization.domains.UPDATE" ] } ], "tags": [ "domainManagement" ], "x-mcp-group": [ "Domain Management" ] } } }, "tags": [ { "name": "domainManagement" } ] }