Skip to main content
Zoho Mail logo
  • Category: email
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 50
  • Triggers: 0
  • Slug: ZOHO_MAIL
  • Version: 20261101_00

Frequently Asked Questions

For Zoho Mail connection issues, verify the region passed during connection initiation. Zoho accounts can be region-specific, so an EU or other regional account may fail if the default/wrong region is used. Retry the connection with the correct Zoho region.

Tools

Slug: ZOHO_MAIL_ACCOUNTS_CREATE_SIGNATURECreate a signature, optionally assign it to users, and return it.

Input Parameters

string
required
Name of the signature.
string
required
HTML or plain-text signature content.
integer
required
Place the signature below quoted content (0) or above it (1).
string
Comma-separated email addresses to assign the signature to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_ACCOUNTS_GET_SIGNATURESList all connected-user signatures or retrieve one signature by ID.

Input Parameters

string
Unique signature ID. Omit to list all signatures for the connected user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTSRetrieves all Zoho Mail accounts associated with the authenticated user. Returns account details including accountId (required for other mail operations), email addresses, storage information, account status, user preferences, and security settings. Use this action first to get the accountId needed for subsequent mailbox, message, folder, and email operations. The accountId is a unique identifier for each mail account. Typical workflow: List accounts → Get accountId → Use accountId in other mail operations.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Zoho Mail data center region. Determines which regional API endpoint to use (e.g., ‘com’ → mail.zoho.com, ‘eu’ → mail.zoho.eu). Choose the region where your Zoho account was created. Options: ‘com’ (US), ‘eu’ (Europe), ‘in’ (India), ‘com.au’ (Australia), ‘jp’ (Japan), ‘ca’ (Canada). If not specified, defaults to ‘com’ (US).
string
Language preference for API responses. Use standard locale codes like ‘en-US’ for American English or ‘en-GB’ for British English. This affects error messages and localized content returned by the API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_ACCOUNTS_UPDATE_DISPLAY_NAMEUpdate the display name of a Zoho Mail account owned by the user.

Input Parameters

string
required
Zoho Mail account ID. Keep this ID as a string.
string
required
New display name for the Zoho Mail account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_DELETE_LABELDelete a label and remove it from associated Zoho Mail messages.

Input Parameters

string
required
ID of the label to delete. Keep this ID as a string.
string
required
Zoho Mail account ID. Keep this ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_DOMAIN_OPERATIONSAdminister a Zoho Mail domain: verify DNS, change hosting and aliases, manage DKIM, catch-all, and notification settings. Some modes delete or disable configuration, so treat every call as potentially irreversible.

Input Parameters

string ("setPrimaryDomain" | "enableMailHosting" | "disableMailHosting" | "verifyDomainByTXT" | "verifyDomainByCName" | "verifyDomainByHTML" | "verifySpfRecord" | "verifyMxRecord" | "makeDomainAsAlias" | "removeDomainAlias" | "addDkimDetail" | "makeDkimDefault" | "deleteDkimDetail" | "regenerateDkimKey" | "verifyDkimKey" | "enableSubDomainStripping" | "disableSubDomainStripping" | "addCatchAllAddress" | "deleteCatchAllAddress" | "addNotificationAddress" | "deleteNotificationAddress")
required
Operation to perform on the domain
string
DKIM record ID; required for makeDkimDefault, deleteDkimDetail, regenerateDkimKey, and verifyDkimKey operations
string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
integer ("1024" | "2048")
Optional DKIM key size (1024 or 2048)
string
DKIM selector; required for addDkimDetail
boolean
Make this DKIM record the default; optional for addDkimDetail
string
required
Fully qualified domain name to operate on
string
Alias domain name; required for alias operations
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
string
Catch-all address; required for addCatchAllAddress
string
required
Zoho Mail organization ID
string
Notification address; required for addNotificationAddress

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_FOLDERS_CREATE_FOLDERCreate a folder in a Zoho Mail account and return its folder record.

Input Parameters

string
required
Zoho Mail account ID. Keep this ID as a string.
string
required
Unique folder name.
string
Parent folder ID. Keep this ID as a string.
string
Parent folder path, such as /Projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_FOLDERS_DELETE_FOLDERDelete a folder from a Zoho Mail account. The first delete moves the folder to Trash; deleting it again from Trash removes it permanently.

Input Parameters

string
required
ID of the folder to delete, as a string. The first delete moves the folder to Trash; deleting it again from Trash removes it permanently.
string
required
Zoho Mail account ID. Keep this ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_FOLDERS_GET_FOLDERRetrieve one Zoho Mail folder by account and folder ID.

Input Parameters

string
required
Folder ID. Keep this ID as a string.
string
required
Zoho Mail account ID. Keep this ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_FOLDERS_LIST_FOLDERSList every folder in a Zoho Mail account. Use the returned folder IDs for message listing, attachment, content, and header operations that require a folder identifier.

Input Parameters

string
required
Zoho Mail account ID as a string; obtain it from ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_FOLDERS_UPDATE_FOLDERRename or move a Zoho Mail folder, or enable or disable its IMAP visibility, and return its observed state from a follow-up read.

Input Parameters

string
required
Folder ID. Keep this ID as a string.
string ("rename" | "move" | "enable_imap" | "disable_imap")
required
Folder change to perform: rename, move, enable_imap, or disable_imap.
string
required
Zoho Mail account ID. Keep this ID as a string.
string
New folder name. Required only when operation is ‘rename’.
string
Destination parent folder ID for ‘move’. Omit to move the folder to the root.
string
Folder after which to position the moved folder. Valid only for ‘move’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_GROUPS_DELETE_GROUP_BULKDelete multiple groups in a single API call. This action permanently removes the specified groups from your Zoho Mail organization. Use this when you need to: - Remove multiple obsolete or unused groups at once - Clean up groups after organizational restructuring - Batch delete groups for administrative purposes Note: Deleted groups cannot be recovered. Ensure you have the correct group IDs before deletion.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
array
required
Array of zgid values (unique group identifiers) to delete. You can retrieve group IDs using the GET /api/organization/{zoid}/groups endpoint to list all groups.
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
string
required
Unique Zoho Organization Identifier (zoid) for your organization. You can retrieve this from the GET /api/organization endpoint or from the Zoho Mail admin console.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_GROUPS_DELETE_GROUP_BY_ZGIDTool to delete a specific mail group by its zgid. Use when you need to remove a group from your organization after confirming the IDs.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
required
Zoho Group ID to delete
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
string
required
Unique Zoho Organization ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_GROUPS_GET_GROUPRetrieve one Zoho Mail organization group, including members and settings.

Input Parameters

string
required
Unique Zoho group ID returned when the group was created or listed.
string
required
Unique Zoho organization ID returned by the Organization Details API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_GROUPS_LIST_MODERATED_MESSAGESList messages held for moderation in one Zoho Mail organization group.

Input Parameters

integer
Maximum held messages to return in this page (1-50). Omit it to use Zoho’s default.
integer
Optional result offset. Pass 0 or greater, or omit it to use Zoho’s default.
Optional sender address or subject search text, sent to Zoho as searchKey.
string
required
ID of the organization group whose held messages to list.
string
required
Zoho Mail organization ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_GROUPS_LIST_MODERATION_EMAILSLists emails held for moderation in a Zoho Mail group, with optional pagination and search. This tool is deprecated.

Input Parameters

integer
Maximum number of moderation emails to return (1-50).
integer
Starting index for this page. Zoho defaults to 1 and also documents 0 in its request sample.
string
required
Unique Zoho mail group ID, returned by the Get All Groups API.
string
Search criterion matched against sender address or subject.
string
required
Unique Zoho organization ID, returned by the Organization Details API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_GROUPS_MODERATE_MESSAGESRelease held group messages for delivery or permanently reject them.

Input Parameters

string ("accept" | "reject")
required
Decision for every specified held message. Accept releases the message for delivery; reject permanently discards it from moderation.
string
required
ID of the organization group holding the messages.
array
required
Non-empty list of held message IDs from ZOHO_MAIL_GROUPS_LIST_MODERATED_MESSAGES.
string
required
Zoho Mail organization ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_LABELS_CREATE_LABELCreate a label in a Zoho Mail account and return its identifiers.

Input Parameters

string
Label color as exactly six hexadecimal digits prefixed by #.
string
required
Zoho Mail account ID. Keep this ID as a string.
string
required
Display name for the new label.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_LABELS_LIST_LABELSList every label configured in a Zoho Mail account.

Input Parameters

string
required
Zoho Mail account whose labels to list. Keep this ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_LIST_BOOKMARKSTool to retrieve all personal bookmarks from a Zoho Mail account. Use when you need to fetch saved bookmarks/links with support for pagination and field filtering.

Input Parameters

integer
Numeric pagination offset. Extract the ‘after’ query value from the previous response’s pagination.next URL.
integer
Number of bookmarks to retrieve. Minimum: 1, Maximum: 399. Defaults to 20.
string
Comma-separated list specifying bookmark details to retrieve (e.g., ‘title,summary,link,linkMetaInfo,collectionName’). If not provided, returns all available details.
string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
boolean
Controls sort order by creation time: true for ascending order, false for descending order. Defaults to descending if not provided.
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_LIST_ORGANIZATION_ACCOUNTSList one offset-paginated page of accounts managed by a Zoho organization.

Input Parameters

integer
Number of organization accounts to retrieve.
integer
Zero-based sequence offset from which to retrieve accounts.
string
required
Zoho organization ID. Keep this ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_LIST_ORGANIZATION_DOMAINSList mail domains configured for a Zoho Mail organization.

Input Parameters

string
required
Zoho organization ID. Keep this ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MANAGE_DOMAIN_ADDRESSESAdd or permanently remove domain aliases, catch-all delivery, and notification addresses.

Input Parameters

string ("add_alias" | "remove_alias" | "add_catch_all" | "delete_catch_all" | "add_notification" | "delete_notification")
required
Add or permanently remove an alias, catch-all address, or notification address.
string
required
Domain already added to the organization.
string
Alias domain required for add_alias and remove_alias.
string
required
Zoho Mail organization ID from organization details.
string
Mailbox address required for add_catch_all.
string
Mailbox address required for add_notification.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MANAGE_DOMAIN_DKIMAdd, verify, regenerate, default, or delete a domain DKIM selector.

Input Parameters

string
Existing DKIM ID; required for make_default, delete, regenerate, and verify.
integer ("1024" | "2048")
Optional RSA key size for add.
string
New selector name; required only for add.
string ("add" | "make_default" | "delete" | "regenerate" | "verify")
required
DKIM lifecycle operation to perform.
boolean
Whether a newly added selector should be default.
string
required
Domain already added to the organization.
string
required
Zoho Mail organization ID from organization details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MANAGE_DOMAIN_HOSTINGSet a primary domain or enable/disable mail hosting and subdomain stripping.

Input Parameters

string ("set_primary" | "enable_mail_hosting" | "disable_mail_hosting" | "enable_subdomain_stripping" | "disable_subdomain_stripping")
required
Set the primary domain, enable/disable mail hosting, or enable/disable subdomain stripping.
string
required
Domain already added to the organization.
string
required
Zoho Mail organization ID from organization details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_CREATE_DRAFTTool to create and save an email draft in Zoho Mail without sending it. Use when composing emails that need to be saved for later editing or sending.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
Email body content. Format depends on mailFormat parameter.
string
Email subject line.
string
Character encoding for the email content (UTF-8 is default). Supports Big5, EUC-JP, ISO-8859-1, etc.
string
required
Unique Zoho Mail account identifier; obtain via Get All User Accounts API.
string
Carbon copy recipient email address(es). Can be comma-separated.
string
required
Recipient email address(es). Required by Zoho Mail API. Can be comma-separated for multiple recipients.
string ("yes" | "no")
Request read receipt; ‘yes’ or ‘no’.
string
Blind carbon copy recipient email address(es). Can be comma-separated.
string ("html" | "plaintext")
Email content format; ‘html’ (default) or ‘plaintext’.
string
required
Sender’s email address; must be valid and tied to the authenticated account.
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_DELETE_EMAILMove one Zoho Mail email to trash or permanently delete it.

Input Parameters

boolean
Permanently delete the email when true; when false, move it to trash.
string
required
Unique identifier of the folder containing the email.
string
required
Unique Zoho Mail account identifier.
string
required
Unique identifier of the email to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_DOWNLOAD_ATTACHMENTDownload one attachment from a Zoho Mail message as a file.

Input Parameters

string
Optional output filename, preferably attachment_name from attachment info. If omitted, a safe name is derived from attachment_id.
string
required
ID of the folder containing the message attachment.
string
required
Zoho Mail account ID as a string; obtain it from ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTS.
string
required
ID of the message containing the attachment.
string
required
ID of the attachment to download; obtain it from ZOHO_MAIL_MESSAGES_GET_ATTACHMENT_INFO.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_GET_ATTACHMENT_INFOGet normal and optional inline attachment metadata for one message.

Input Parameters

string
required
ID of the folder containing the message; obtain it from a folder or message listing.
string
required
Zoho Mail account ID as a string; obtain it from ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTS.
string
required
ID of the message whose attachment metadata to retrieve.
boolean
Whether to include inline-image metadata and content IDs in addition to normal attachments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_GET_MESSAGE_CONTENTTool to retrieve the full content/body of a specific Zoho Mail email. Use when you need to fetch the complete email content after listing or searching messages, as list/search endpoints typically return only metadata/summary.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
required
Unique folder ID (19-digit string) to identify the folder containing the message (retrievable from Get All Folders API).
string
required
Unique Zoho account ID (19-digit string) to identify the specific account (obtainable via Get User Account Details API).
string
required
Unique message ID (19-digit string) of the email to retrieve content for (available from List Emails API).
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
boolean
If true, includes block quote content with the original email; if false, excludes block content. Useful for threaded/reply block retrieval.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_GET_MESSAGE_HEADERSGet one email’s internet message headers without flattening repeated values.

Input Parameters

boolean
True returns RFC-style multiline header text; false returns a mapping of header names to arrays of values.
string
required
ID of the folder containing the message.
string
required
Zoho Mail account ID as a string; obtain it from ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTS.
string
required
ID of the message whose internet headers to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_GET_MESSAGE_METADATARetrieve one email’s complete metadata record by account, folder, and message ID.

Input Parameters

string
required
ID of the folder containing the message. Keep this ID as a string.
string
required
Zoho Mail account ID. Keep this ID as a string.
string
required
ID of the message whose metadata to retrieve. Keep this ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_LIST_EMAILSTool to retrieve a list of emails from a Zoho Mail account folder. Use when you need to fetch emails from inbox or specific folder, with support for filtering by read status, attachments, flags, and pagination.

Input Parameters

integer
Number of emails to retrieve. Minimum: 1, Maximum: 200. Defaults to 10.
integer
Starting sequence number of the emails to retrieve for pagination. Defaults to 1.
string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string ("read" | "unread" | "all")
Filter by read status. Options: ‘read’, ‘unread’, or ‘all’. If omitted, Zoho applies its default.
boolean
If true, retrieves only flagged/starred emails. Defaults to false.
string ("date" | "messageId" | "size")
Field to sort results by. Options: ‘date’, ‘messageId’, ‘size’. If not provided, uses API default sorting.
string
Unique folder ID (19-digit string) to identify the folder containing the messages (retrievable from Get All Folders API). If not provided, defaults to inbox.
string
required
Unique Zoho account ID (19-digit string) to identify the specific account (obtainable via Get User Account Details API).
boolean
Sort order: true for ascending, false for descending. Only applies if sort_by is provided.
boolean
If true, retrieves emails that are part of conversations/threads. Defaults to false.
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
boolean
If true, retrieves only emails with attachments. Defaults to false.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_REPLY_TO_EMAILSend or schedule a reply while preserving the original message thread. Delivery is an irreversible external side effect.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
Email body content for the reply. Format depends on mailFormat parameter.
string
Email subject line. If not provided, Zoho Mail will use the original subject with ‘Re:’ prefix.
string
Character encoding for the email content (UTF-8 is default). Supports Big5, EUC-JP, ISO-8859-1, etc.
string
Time zone for scheduled email. Live Zoho calls require it for preset and custom schedules.
string
required
Unique Zoho Mail account identifier; obtain via Get All User Accounts API.
string
Carbon copy recipient email address(es). Can be comma-separated.
string
required
Unique identifier for the message to reply to; obtain via List Emails API.
string
required
Recipient email address(es). Can be comma-separated for multiple recipients.
string ("yes" | "no")
Request read receipt; ‘yes’ or ‘no’.
string
Blind carbon copy recipient email address(es). Can be comma-separated.
boolean
Enable email scheduling; set to true to schedule the reply for later delivery.
string ("html" | "plaintext")
Email content format; ‘html’ (default) or ‘plaintext’.
string
required
Sender’s email address; must be valid and tied to the authenticated account.
string
Custom schedule time in format MM/DD/YYYY HH:MM:SS. Required when scheduleType is 6.
integer
Schedule type: 1-5 for preset times, 6 for custom scheduling. Required if isSchedule is true.
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_SEND_EMAILSend an email immediately or schedule it for later delivery. Delivery is an irreversible external side effect; use only confirmed recipients.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
Email body content. Format depends on mailFormat parameter.
string
Email subject line.
string
Character encoding for the email content (UTF-8 is default). Supports Big5, EUC-JP, ISO-8859-1, etc.
boolean
Whether attachments should be displayed inline in the email body (useful for images in HTML emails). Default: false (normal attachment).
string
Timezone for scheduled delivery. Live Zoho calls require this for preset and custom schedules; use an IANA name such as ‘America/Los_Angeles’.
string
required
Unique Zoho Mail account identifier; obtain via Get All User Accounts API.
string
Carbon copy recipient email address(es). Can be comma-separated.
string
required
Recipient email address(es). Can be comma-separated for multiple recipients.
string ("yes" | "no")
Request read receipt; ‘yes’ or ‘no’.
string
File(s) to attach to the email. The file name will be used as the attachment filename.
string
Blind carbon copy recipient email address(es). Can be comma-separated.
boolean
Whether to schedule the email for later sending. Default: false (send immediately).
string ("html" | "plaintext")
Email content format; ‘html’ (default) or ‘plaintext’.
string
required
Sender’s email address; must be valid and tied to the authenticated account.
string
Custom schedule datetime in MM/DD/YYYY HH:MM:SS format (required if scheduleType=6).
integer
Scheduling type when isSchedule is true. Values: 1 (1 hour), 2 (2 hours), 3 (4 hours), 4 (next morning), 5 (next afternoon), 6 (custom date/time).
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_UPDATE_EMAILSUpdates specified Zoho Mail messages: change read state, move, flag, apply or remove labels, archive or unarchive, or change spam state. This tool is deprecated.

Input Parameters

string ("info" | "important" | "followup" | "flag_not_set")
Flag value. Required only when operation is ‘set_flag’.
string
Restrict the update to messages in this folder. Supported for move, flag, label, and spam operations.
array
One or more label IDs. Required only for ‘apply_labels’ and ‘remove_labels’.
string ("mark_read" | "mark_unread" | "move" | "set_flag" | "apply_labels" | "remove_labels" | "remove_all_labels" | "archive" | "unarchive" | "mark_spam" | "mark_not_spam")
required
Update to perform: change read state, move, set a flag, change labels, archive state, or change spam state.
string
required
Zoho Mail account ID. Keep this ID as a string to avoid precision loss.
array
required
One or more Zoho message IDs to update. Keep every ID as a string.
boolean
Whether move, set_flag, or apply_labels should include archived messages. Omit to use Zoho’s default of false.
string
Destination folder ID. Required only when operation is ‘move’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_UPDATE_MESSAGESBatch-update message or thread read, folder, flag, label, archive, or spam state.

Input Parameters

string ("info" | "important" | "followup" | "flag_not_set")
Flag to set or clear. Required only when mode is set_flag; flag_not_set clears the flag.
string ("mark_as_read" | "mark_as_unread" | "move" | "set_flag" | "apply_labels" | "remove_labels" | "remove_all_labels" | "archive" | "unarchive" | "move_to_spam" | "mark_not_spam")
required
Update to apply: change read state, move, flag, label, archive, or spam state.
string
Folder containing the target messages. Required when is_folder_specific is true and otherwise omitted.
array
Non-empty label ID list. Required only when mode is apply_labels or remove_labels.
string
required
Zoho Mail account ID as a string; obtain it from ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTS.
boolean
Archive-context flag accepted only for move, set_flag, and apply_labels. Omit it for all other modes.
array
Non-empty thread ID list for a thread-wide update. Provide exactly one of thread_ids or message_ids.
array
Non-empty message ID list to update. Provide exactly one of message_ids or thread_ids.
boolean
Whether the update applies only within one folder. Allowed only for move, set_flag, apply_labels, remove_labels, remove_all_labels, move_to_spam, and mark_not_spam.
string
Destination folder ID. Required only when mode is move.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_UPLOAD_ATTACHMENTDeprecated: uploads one attachment to a Zoho Mail account without sending an email and returns file-store metadata.

Input Parameters

string
Filename to send to Zoho. Defaults to the uploaded file’s name.
boolean
Whether Zoho should prepare the attachment for inline display in an email body.
string
required
Zoho Mail account identifier; obtain it from the list accounts action.
object
required
Single file to upload to Zoho Mail without sending an email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_MESSAGES_UPLOAD_ATTACHMENTSDeprecated: Upload one or more attachments to a Zoho Mail account for later use in a message, optionally as inline content. Returns temporary attachment metadata; it does not send a message.

Input Parameters

boolean
Whether the uploaded files are intended as inline message content rather than normal attachments.
string
required
Zoho Mail account ID as a string; obtain it from ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTS.
array
required
One or more files to upload. Each file is sent as a repeated attach multipart part using its name and MIME type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_ORGANIZATION_GET_USER_STORAGE_DETAILSTool to retrieve storage details for a specific user in the organization. Use when you need to know a user’s total and used storage quotas.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
required
Unique Zoho User ID (path parameter)
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
string
required
Unique Zoho Organization ID (path parameter)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_ORGANIZATION_UPDATE_SPAM_PROCESS_TYPETool to update organization spam processing type. Use when changing the spam filtering strategy for an organization.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
string
required
Unique Zoho Organization Identifier (zoid) for the target organization. Obtain this from organization details API or admin console.
string ("Off" | "complete" | "content" | "sender" | "sender_header")
required
Spam filtering level: Off disables filtering; sender checks sender only; sender_header checks sender and headers; content scans content; complete applies all checks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_ORGANIZATION_UPDATE_USER_STORAGEUpdates a user’s storage allocation within a Zoho Mail organization. Can modify either base storage plan or extra storage add-ons. Use this when you need to: - Change a user’s base storage plan (e.g., from basic to mailPremium) - Add or modify extra storage add-ons for a user Prerequisites: You must have valid zoid (organization ID) and zuid (user ID) before calling this action.

Input Parameters

string ("updateBaseStorage" | "updateExtraStorage")
required
Operation type: ‘updateBaseStorage’ or ‘updateExtraStorage’.
string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
required
Zoho User ID for the user whose storage you want to update. Obtain from list organization users API.
string ("newMail5gb" | "newMail10gb" | "mailPremium" | "basic" | "professional")
Base plan to set; required when mode=‘updateBaseStorage’.
array
Extra storage add-on(s); required when mode=‘updateExtraStorage’. Each item must be ‘<size>:<count>’ (e.g., ‘5gb:1’, ‘25gb:2’) where size is one of: 5gb, 25gb, 50gb, 100gb, 200gb.
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
string
required
Zoho Organization ID. Obtain from Organization Details API or list organization users endpoint.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_SEARCH_MESSAGESTool to search emails in a Zoho Mail account using Zoho’s searchKey syntax. Use when you need to find specific emails by sender, subject, keywords, status (e.g., unread), attachments, or flags. Returns messageId and folderId needed to fetch full message content.

Input Parameters

integer
Number of emails to retrieve per request. Minimum: 1, Maximum: 200. Defaults to 10.
integer
Starting sequence number for pagination. Defaults to 1.
string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
boolean
If true, includes recipient details (To/CC fields) in the response. Defaults to false.
string
required
Unique Zoho account ID (19-digit string) to identify the specific account (obtainable via Get User Account Details API).
string
required
Search criteria using Zoho Mail search syntax. Examples: ‘newMails’ (unread messages), ‘sender:sender@example.com’ (by sender), ‘subject:meeting’ (by subject), ‘to:recipient@example.com’ (by recipient), ‘has:attachment’ (with attachments), and ‘has:flags’ (flagged messages). Combine criteria with ’::’.
integer
Unix timestamp in milliseconds; Zoho returns emails received before this time. If omitted, Zoho applies its default time window.
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_TASKS_CREATE_GROUP_TASKCreate a task in a Zoho Mail group.

Input Parameters

string
required
Non-empty task title.
string ("inprogress" | "completed")
Initial task status.
object
Nested subtask object. Use the same documented Zoho task body fields and camelCase wire names as the parent task.
string
Zoho user ID of the member assigned to the task.
string
Task due date in DD/MM/YYYY format.
string
required
Zoho group ID in which to create the task. Keep this ID as a string.
string ("high" | "medium" | "low")
Initial task priority.
integer
Positive number of times the task should recur.
string
Zoho Mail account identifier linked to the task.
string
Unique email message identifier linked to the task.
string
Unique project identifier for this group task.
string
Recurrence start date in DD/MM/YYYY format.
array
Uploaded attachment paths.
string
Task description.
string
Recurrence end date in DD/MM/YYYY format.
string
Reminder date and time in ISO 8601 format.
boolean
Whether to send the task reminder by email.
string
Unique identifier of the parent task.
boolean
Whether to show a task reminder notification.
string ("Daily" | "Weekly" | "Monthly" | "Yearly")
Task recurrence pattern.
integer
Weekly recurrence day, from 1 (Sunday) to 7 (Saturday).
array
Uploaded attachment store names.
integer
Positive interval between task recurrences.
integer
Yearly recurrence month, from 0 (January) to 11 (December).
integer
Yearly recurrence weekday, from 1 (Sunday) to 7 (Saturday).
boolean
Whether daily recurrence is limited to weekdays.
integer
Monthly recurrence weekday, from 1 (Sunday) to 7 (Saturday).
integer
Yearly recurrence date, from 1 to 31.
integer
Monthly recurrence date, from 1 to 31.
integer
Yearly recurrence week number, from 1 to 4.
integer
Monthly recurrence week number, from 1 to 4.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_TASKS_CREATE_PERSONAL_TASKCreate a personal task for the connected Zoho Mail user.

Input Parameters

string
required
Non-empty task title.
string ("inprogress" | "completed")
Task status: inprogress or completed.
object
Task fields for a subtask to create with this task.
string
Zoho user ID of the assignee; defaults to the current user.
string
Task due date in DD/MM/YYYY format.
string ("high" | "medium" | "low")
Task priority: high, medium, or low.
integer
Positive number of times the task should recur.
string
Zoho Mail account identifier linked to the task.
string
Unique email message identifier linked to the task.
string
Unique project identifier for the task.
string
Recurrence start date in DD/MM/YYYY format.
array
Uploaded attachment paths.
string
Non-empty task description.
string
Recurrence end date in DD/MM/YYYY format.
string
Reminder date and time in ISO 8601 format.
boolean
Whether to send the task reminder by email.
string
Unique identifier of the parent task.
boolean
Whether to send a popup reminder notification.
string ("Daily" | "Weekly" | "Monthly" | "Yearly")
Task recurrence pattern.
integer
Weekly recurrence day, from 1 (Sunday) to 7 (Saturday).
array
Uploaded attachment store names.
integer
Positive number of recurrence intervals between occurrences.
integer
Month for yearly recurrence, from 0 (January) to 11 (December).
integer
Weekday for yearly recurrence, from 1 (Sunday) to 7 (Saturday).
boolean
Whether daily recurrence is limited to weekdays.
integer
Weekday for monthly recurrence, from 1 (Sunday) to 7 (Saturday).
integer
Day of the month for yearly recurrence (1-31).
integer
Day of the month for monthly recurrence (1-31).
integer
Week number in the month for yearly weekday recurrence (1-4).
integer
Week number in the month for monthly weekday recurrence (1-4).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_TASKS_LIST_PERSONAL_TASKSList one offset-paginated page of personal tasks for the connected Zoho Mail user. Use from_index and limit to retrieve additional pages.

Input Parameters

integer
Maximum number of tasks to retrieve, from 1 through 499.
string ("inprogress" | "completed")
Filter tasks by inprogress or completed status.
integer
Zero-based task offset sent to Zoho as ‘from’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_TASKS_UPDATE_GROUP_TASKUpdate one documented field on a task in a Zoho Mail group.

Input Parameters

string
New non-empty task title. Provide exactly one update field.
string ("inprogress" | "completed")
New task status. Provide exactly one update field.
string
required
Task ID to update. Keep this ID as a string.
string
New task due date in DD/MM/YYYY format.
string
required
Zoho Mail group ID containing the task. Keep this ID as a string.
string ("high" | "medium" | "low")
New task priority. Provide exactly one update field.
string
New project ID for the task. Keep this ID as a string.
string
New assignee ID for the task. Keep this ID as a string.
string
New non-empty task description. Provide exactly one update field.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_UPDATE_GROUP_SETTINGSTool to update group settings. Use after group creation to adjust general or text settings.

Input Parameters

string ("com" | "us" | "eu" | "in" | "com.au" | "au" | "com.cn" | "cn" | "jp" | "ca" | "ae" | "sa" | "uk" | "sg")
Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
string
required
Group ID to update settings for
object
Text settings object for the group
string
Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
string
required
Zoho Mail organization ID
object
General settings object for the group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_UPDATE_ORGANIZATION_ACCOUNTEnable or disable an external account, or update incoming, outgoing, IMAP, POP, or ActiveSync status for an organization-managed mailbox.

Input Parameters

boolean
Whether to enable the selected incoming, outgoing, IMAP, POP, or mobile-sync service. Required for status operations and invalid for external-account enable/disable operations.
string
required
Zoho user ID (zuid) that owns the account. Keep this ID as a string.
string ("enable_external_account" | "disable_external_account" | "update_incoming_status" | "update_outgoing_status" | "update_imap_status" | "update_pop_status" | "update_mobile_sync_status")
required
Account change to perform. External-account operations enable or disable an added IMAP/POP account; status operations change the selected mailbox access setting.
string
required
Organization mailbox or external IMAP/POP account ID. Keep this ID as a string.
string
required
Zoho organization ID. Keep this ID as a string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MAIL_VERIFY_DOMAIN_RECORDSVerify domain ownership, SPF, or MX DNS records for a Zoho Mail domain.

Input Parameters

string
required
Domain already added to the organization.
string ("txt" | "cname" | "html" | "spf" | "mx")
required
Record to verify: txt/cname/html prove ownership; spf and mx verify mail DNS.
string
required
Zoho Mail organization ID from organization details.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not