Zoho Mail

Overview

Zoho Mail is a secure and ad-free email hosting platform with collaboration tools, calendar integration, and extensive administrative controls. With the Zoho Mail integration in SquadOS, your agents can send emails, read and search messages, create drafts, reply to threads, and manage groups and corporate domain settings.

• Official website: https://www.zoho.com/mail/
• Composio documentation: docs.composio.dev/toolkits/zoho_mail

Authentication

This tool uses OAuth 2.0 (OAUTH2) to connect.

You will need to authorize access to your Zoho Mail account via OAuth. No manual API key is required — the authorization flow is managed by Composio.

Field	Required	Description
OAuth authorization	Yes	Access granted via OAuth 2.0 flow on the Composio secure connection page.

How to connect in SquadOS

1. Go to Tools in the side menu (/admin/tools).
2. Open the Available tab and search for Zoho Mail.
3. Click the card to open the details modal and hit Connect.
4. You’re taken to the secure connection page hosted by Composio, where you authorize access to your Zoho Mail account via OAuth 2.0.
5. Once done, you’re sent back to SquadOS with the account connected and the tool available to your agents. (Connection-flow details in Organization Tools.)

Available actions

List Zoho Mail Accounts

ZOHO_MAIL_ACCOUNTS_LIST_ACCOUNTS

Retrieves 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

Name	Type	Required	Description
region	string	No	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).
accept_language	string	No	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.
use_bearer_auth	boolean	No	Internal parameter for authentication handling. Keep as False (default) unless specifically instructed otherwise. When False, automatically converts OAuth tokens to Zoho’s required ‘Zoho-oauthtoken’ format.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Domain Operations

ZOHO_MAIL_DOMAIN_OPERATIONS

Tool to perform domain operations like verify, set primary domain, hosting, aliases, MX/SPF checks, DKIM management, and notifications. Use after creating or retrieving a domain.

Input parameters

Name	Type	Required	Description
mode	string	Yes	Operation to perform on the domain. Options: ‘setPrimaryDomain’, ‘enableMailHosting’, ‘disableMailHosting’, ‘verifyDomainByTXT’, ‘verifyDomainByCName’, ‘verifyDomainByHTML’, ‘verifySpfRecord’, ‘verifyMxRecord’, ‘makeDomainAsAlias’, ‘removeDomainAlias’, ‘addDkimDetail’, ‘makeDkimDefault’, ‘deleteDkimDetail’, ‘regenerateDkimKey’, ‘verifyDkimKey’, ‘enableSubDomainStripping’, ‘disableSubDomainStripping’, ‘addCatchAllAddress’, ‘deleteCatchAllAddress’, ‘addNotificationAddress’, ‘deleteNotificationAddress’.
zoid	integer	Yes	Organization ID (ZOID).
dkimId	integer	No	DKIM record ID; required for makeDkimDefault, deleteDkimDetail, regenerateDkimKey, and verifyDkimKey operations.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
keySize	integer	No	DKIM key size (1024 or 2048); required for addDkimDetail.
selector	string	No	DKIM selector; required for addDkimDetail.
isDefault	boolean	No	Make this DKIM record the default; optional for addDkimDetail.
domainName	string	Yes	Fully qualified domain name to operate on.
domainAlias	string	No	Alias domain name; required for alias operations.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
catchAllAddress	string	No	Catch-all address; required for addCatchAllAddress.
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.
notificationAddress	string	No	Notification address; required for addNotificationAddress.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get All Bookmarks

ZOHO_MAIL_GET_ALL_BOOKMARKS

Tool 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

Name	Type	Required	Description
after	string	No	Specifies the starting point for pagination. Use the value from the ‘next’ field in previous response pagination to retrieve subsequent pages.
limit	integer	No	Number of bookmarks to retrieve. Minimum: 1, Maximum: 399. Defaults to 20.
fields	string	No	Comma-separated list specifying bookmark details to retrieve (e.g., ‘title,summary,link,linkMetaInfo,collectionName’). If not provided, returns all available details.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
is_prev	boolean	No	Controls sort order by creation time: true for ascending order, false for descending order. Defaults to descending if not provided.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Groups in Bulk

ZOHO_MAIL_GROUPS_DELETE_GROUP_BULK

Delete 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, or batch delete groups for administrative purposes. Note: Deleted groups cannot be recovered. Ensure you have the correct group IDs before deletion.

Input parameters

Name	Type	Required	Description
zoid	integer	Yes	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.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
groupList	array	Yes	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.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Delete Group

ZOHO_MAIL_GROUPS_DELETE_GROUP_BY_ZGID

Tool 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

Name	Type	Required	Description
zgid	integer	Yes	Zoho Group ID to delete.
zoid	integer	Yes	Unique Zoho Organization ID.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Create Email Draft

ZOHO_MAIL_MESSAGES_CREATE_DRAFT

Tool 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

Name	Type	Required	Description
mode	string	No	Operation mode; must be ‘draft’ to save as draft (not send).
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
content	string	No	Email body content. Format depends on mailFormat parameter.
subject	string	No	Email subject line.
encoding	string	No	Character encoding for the email content (UTF-8 is default). Supports Big5, EUC-JP, ISO-8859-1, etc.
accountId	string	Yes	Unique Zoho Mail account identifier; obtain via Get All User Accounts API.
ccAddress	string	No	Carbon copy recipient email address(es). Can be comma-separated.
toAddress	string	Yes	Recipient email address(es). Required by Zoho Mail API. Can be comma-separated for multiple recipients.
askReceipt	string	No	Request read receipt; ‘yes’ or ‘no’.
bccAddress	string	No	Blind carbon copy recipient email address(es). Can be comma-separated.
mailFormat	string	No	Email content format; ‘html’ (default) or ‘plaintext’.
fromAddress	string	Yes	Sender’s email address; must be valid and tied to the authenticated account.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Message Content

ZOHO_MAIL_MESSAGES_GET_MESSAGE_CONTENT

Tool 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

Name	Type	Required	Description
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
folder_id	string	Yes	Unique folder ID (19-digit string) to identify the folder containing the message (retrievable from Get All Folders API).
account_id	string	Yes	Unique Zoho account ID (19-digit string) to identify the specific account (obtainable via Get User Account Details API).
message_id	string	Yes	Unique message ID (19-digit string) of the email to retrieve content for (available from List Emails API).
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.
include_block_content	boolean	No	If true, includes block quote content with the original email; if false, excludes block content. Useful for threaded/reply block retrieval.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

List Emails

ZOHO_MAIL_MESSAGES_LIST_EMAILS

Tool 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

Name	Type	Required	Description
limit	integer	No	Number of emails to retrieve. Minimum: 1, Maximum: 200. Defaults to 10.
start	integer	No	Starting sequence number of the emails to retrieve for pagination. Defaults to 1.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
status	string	No	Filter by read status. Options: ‘read’, ‘unread’. If not provided, retrieves all emails regardless of read status.
flagged	boolean	No	If true, retrieves only flagged/starred emails. Defaults to false.
sort_by	string	No	Field to sort results by. Options: ‘date’, ‘messageId’, ‘size’. If not provided, uses API default sorting.
folder_id	string	No	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.
account_id	string	Yes	Unique Zoho account ID (19-digit string) to identify the specific account (obtainable via Get User Account Details API).
search_key	string	No	Search term to filter emails by subject, sender, or content. Use to find specific emails matching this keyword.
sort_order	boolean	No	Sort order: true for ascending, false for descending. Only applies if sort_by is provided.
threaded_mails	boolean	No	If true, retrieves emails that are part of conversations/threads. Defaults to false.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
only_attachment	boolean	No	If true, retrieves only emails with attachments. Defaults to false.
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Reply to Email

ZOHO_MAIL_MESSAGES_REPLY_TO_EMAIL

Tool to reply to an existing email via Zoho Mail API. Use when you need to send a reply to a received email message, maintaining email threading.

Input parameters

Name	Type	Required	Description
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
content	string	Yes	Email body content for the reply. Format depends on mailFormat parameter.
subject	string	No	Email subject line. If not provided, Zoho Mail will use the original subject with ‘Re:’ prefix.
encoding	string	No	Character encoding for the email content (UTF-8 is default). Supports Big5, EUC-JP, ISO-8859-1, etc.
timeZone	string	No	Time zone for scheduled email. Required when scheduleType is 6.
accountId	string	Yes	Unique Zoho Mail account identifier; obtain via Get All User Accounts API.
ccAddress	string	No	Carbon copy recipient email address(es). Can be comma-separated.
messageId	string	Yes	Unique identifier for the message to reply to; obtain via List Emails API.
toAddress	string	Yes	Recipient email address(es). Can be comma-separated for multiple recipients.
askReceipt	string	No	Request read receipt; ‘yes’ or ‘no’.
bccAddress	string	No	Blind carbon copy recipient email address(es). Can be comma-separated.
isSchedule	boolean	No	Enable email scheduling; set to true to schedule the reply for later delivery.
mailFormat	string	No	Email content format; ‘html’ (default) or ‘plaintext’.
fromAddress	string	Yes	Sender’s email address; must be valid and tied to the authenticated account.
scheduleTime	string	No	Custom schedule time in format MM/DD/YYYY HH:MM:SS. Required when scheduleType is 6.
scheduleType	integer	No	Schedule type: 1-5 for preset times, 6 for custom scheduling. Required if isSchedule is true.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Send Email

ZOHO_MAIL_MESSAGES_SEND_EMAIL

Tool to send an email via Zoho Mail API. Use when you need to send emails immediately to recipients.

Input parameters

Name	Type	Required	Description
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
content	string	Yes	Email body content. Format depends on mailFormat parameter.
subject	string	Yes	Email subject line.
encoding	string	No	Character encoding for the email content (UTF-8 is default). Supports Big5, EUC-JP, ISO-8859-1, etc.
isInline	boolean	No	Whether attachments should be displayed inline in the email body (useful for images in HTML emails). Default: false (normal attachment).
timeZone	string	No	Timezone for custom schedule (required if scheduleType=6). Example: ‘GMT 5:30 (India Standard Time - Asia/Calcutta)’.
accountId	string	Yes	Unique Zoho Mail account identifier; obtain via Get All User Accounts API.
ccAddress	string	No	Carbon copy recipient email address(es). Can be comma-separated.
toAddress	string	Yes	Recipient email address(es). Can be comma-separated for multiple recipients.
askReceipt	string	No	Request read receipt; ‘yes’ or ‘no’.
attachment	string	No	File(s) to attach to the email. FileUploadable object(s) where ‘name’ is the attachment filename.
bccAddress	string	No	Blind carbon copy recipient email address(es). Can be comma-separated.
isSchedule	boolean	No	Whether to schedule the email for later sending. Default: false (send immediately).
mailFormat	string	No	Email content format; ‘html’ (default) or ‘plaintext’.
fromAddress	string	Yes	Sender’s email address; must be valid and tied to the authenticated account.
scheduleTime	string	No	Custom schedule datetime in MM/DD/YYYY HH:MM:SS format (required if scheduleType=6).
scheduleType	integer	No	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).
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Get Organization User Storage Details

ZOHO_MAIL_ORGANIZATION_GET_USER_STORAGE_DETAILS

Tool 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

Name	Type	Required	Description
zoid	integer	Yes	Unique Zoho Organization ID (path parameter).
zuid	integer	Yes	Unique Zoho User ID (path parameter).
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Organization Spam Process Type

ZOHO_MAIL_ORGANIZATION_UPDATE_SPAM_PROCESS_TYPE

Tool to update organization spam processing type. Use when changing the spam filtering strategy for an organization.

Input parameters

Name	Type	Required	Description
mode	string	No	Operation mode; automatically set to ‘updateSpamProcessType’. This field is managed internally.
zoid	integer	Yes	Unique Zoho Organization Identifier (zoid) for the target organization. Obtain this from organization details API or admin console.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
spamVO	object	Yes	Spam filtering configuration object containing the desired spam process type setting.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update User Storage

ZOHO_MAIL_ORGANIZATION_UPDATE_USER_STORAGE

Updates 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) or add/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

Name	Type	Required	Description
mode	string	Yes	Operation type: ‘updateBaseStorage’ or ‘updateExtraStorage’.
zoid	integer	Yes	Zoho Organization ID. Obtain from Organization Details API or list organization users endpoint.
zuid	integer	Yes	Zoho User ID for the user whose storage you want to update. Obtain from list organization users API.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
plan_type	string	No	Base plan to set; required when mode=‘updateBaseStorage’. Options: ‘newMail5gb’, ‘newMail10gb’, ‘mailPremium’, ‘basic’, ‘professional’.
addon_type	array	No	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.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Search Messages

ZOHO_MAIL_SEARCH_MESSAGES

Tool 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

Name	Type	Required	Description
limit	integer	No	Number of emails to retrieve per request. Minimum: 1, Maximum: 200. Defaults to 10.
start	integer	No	Starting sequence number for pagination. Defaults to 1.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
includeto	boolean	No	If true, includes recipient details (To/CC fields) in the response. Defaults to false.
account_id	string	Yes	Unique Zoho account ID (19-digit string) to identify the specific account (obtainable via Get User Account Details API).
search_key	string	Yes	Search criteria using Zoho Mail search syntax. Examples: ‘newMails’ (unread messages), ‘from:sender@example.com’ (by sender), ‘subject:meeting’ (by subject), ‘to:recipient@example.com’ (by recipient), ‘hasattachment’ (with attachments), ‘flagged’ (starred messages). Combine multiple criteria with spaces.
received_time	integer	No	Unix timestamp in milliseconds to filter emails received after this time. If not provided, defaults to emails from 2 minutes prior.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.

Update Group Settings

ZOHO_MAIL_UPDATE_GROUP_SETTINGS

Tool to update group settings. Use after group creation to adjust general or text settings.

Input parameters

Name	Type	Required	Description
mode	string	Yes	Operation mode, must be ‘updateMailGroupOptions’.
zgid	integer	Yes	Group ID to update settings for.
zoid	integer	Yes	Organization ID.
region	string	No	Optional Zoho data center domain to target. One of: ‘com’, ‘eu’, ‘in’, ‘com.au’, ‘jp’, ‘ca’.
accept_language	string	No	Optional Accept-Language header value (e.g., ‘en-US’, ‘en-GB’).
use_bearer_auth	boolean	No	If true, keeps ‘Bearer <token>’ Authorization header; otherwise converts to ‘Zoho-oauthtoken <token>’.
groupTextSettings	object	No	Text settings object for the group.
groupGeneralSettings	object	No	General settings object for the group.

Output

Name	Type	Required	Description
data	string	Yes	Data from the action execution.
error	string	No	Error if any occurred during the execution of the action.
successful	boolean	Yes	Whether or not the action execution was successful.