> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Zoho

> Zoho is a suite of cloud applications including CRM, email marketing, and collaboration tools, enabling businesses to automate and scale operations

![Zoho logo](https://mintcdn.com/composio-preview/11RkPhDhzt1wdr6a/images/toolkits/zoho.svg?fit=max\&auto=format\&n=11RkPhDhzt1wdr6a\&q=85\&s=65704865c04e98660b2244a5e5047c95)

* **Category:** crm
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** Yes
* **Tools:** 103
* **Triggers:** 0
* **Slug:** `ZOHO`
* **Version:** 20261103\_00

## Frequently Asked Questions

> [accordion] How do I set up custom OAuth credentials for Zoho CRM?
>
> For a step-by-step guide on creating and configuring your own Zoho CRM OAuth credentials with Composio, see [How to create OAuth credentials for Zoho CRM](https://composio.dev/auth/zoho).

## Tools

> [accordion] Add Tags to Zoho CRM Records
>
> **Slug:** `ZOHO_ADD_TAGS_TO_RECORDS`
>
> Apply one or more existing tags to up to 500 records in a Zoho CRM module, optionally replacing each record's existing tags.
>
> #### Input Parameters
>
> **tags** `array` *required*
>
> Existing tags to apply. Each tag must contain its id or name; when both are supplied, Zoho gives the id precedence.
>
> **over\_write** `boolean`
>
> Whether to replace each record's existing tags. False adds these tags without removing existing tags.
>
> **record\_ids** `array` *required*
>
> IDs of the records to tag. Zoho accepts 1 to 500 IDs per request.
>
> **module\_api\_name** `string` *required*
>
> Case-sensitive API name of the Zoho CRM module containing the records, such as Leads, Contacts, Deals, or a custom module API name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Associate Email with Zoho CRM Record
>
> **Slug:** `ZOHO_ASSOCIATE_EMAIL`
>
> Add an existing sent or received email to a Zoho CRM record's history.
>
> #### Input Parameters
>
> **cc** `array`
>
> Carbon-copy recipients of the email.
>
> **to** `array` *required*
>
> Primary recipients of the email.
>
> **bcc** `array`
>
> Blind-carbon-copy recipients of the email.
>
> **sent** `boolean` *required*
>
> Whether the email was sent by the owner. Use false for a received email.
>
> **owner** `object`
>
> Owner of the email when an administrator associates another user's email.
>
> **content** `string` *required*
>
> Body of the existing email, as plain text or HTML.
>
> **subject** `string` *required*
>
> Subject line of the existing email.
>
> **date\_time** `string` *required*
>
> ISO 8601 date and time at which the email was sent or received.
>
> **record\_id** `string` *required*
>
> Unique ID of the CRM record whose email history will be updated.
>
> **from\_email** `object` *required*
>
> Sender name and email address.
>
> **attachments** `array`
>
> Attachments previously uploaded to ZFS. Their combined size must not exceed 10 MB.
>
> **mail\_format** `string`
>
> Set to html when content contains HTML markup or inline images.
>
> **linked\_record** `object`
>
> An additional CRM record to map to the associated email.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the CRM module containing the record, such as Leads, Contacts, Deals, or a custom module API name.
>
> **original\_message\_id** `string` *required*
>
> Unique Message-ID value from the original email header.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Zoho CRM Lead
>
> **Slug:** `ZOHO_CONVERT_ZOHO_LEAD`
>
> Converts a lead into a contact, account, and optionally a deal in Zoho CRM.
>
> #### Input Parameters
>
> **Deals** `object`
>
> Deal to create while converting the lead.
>
> **lead\_id** `string` *required*
>
> The unique ID of the lead to convert.
>
> **assign\_to** `string`
>
> User ID to assign as the owner of the new contact/account.
>
> **overwrite** `boolean`
>
> Whether to overwrite the account name in the contact if it already exists and the company names mismatch.
>
> **account\_id** `string`
>
> ID of an existing account to associate with the converted lead.
>
> **contact\_id** `string`
>
> ID of an existing contact to associate with the converted lead.
>
> **carry\_over\_tags** `object`
>
> Tags to carry over to converted records.
>
> **notify\_lead\_owner** `boolean`
>
> Notify the lead owner about the conversion via email.
>
> **move\_attachments\_to** `object`
>
> Module to which attachments from the lead should be moved.
>
> **notify\_new\_entity\_owner** `boolean`
>
> Notify the new owner of the contact/account via email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Count Zoho CRM Records
>
> **Slug:** `ZOHO_COUNT_RECORDS`
>
> Count all records or records matching one filter in a Zoho CRM module.
>
> #### Input Parameters
>
> **word** `string`
>
> Word searched across record fields. Cannot be combined with another search filter or custom\_view\_id.
>
> **email** `string`
>
> Email address used to count matching records. Cannot be combined with another search filter or custom\_view\_id.
>
> **phone** `string`
>
> Phone number used to count matching records. Cannot be combined with another search filter or custom\_view\_id.
>
> **approved** `string ("true" | "false" | "both")`
>
> Whether to count approved records: true, false, or both.
>
> **criteria** `string`
>
> Zoho criteria expression used to count matching records. Cannot be combined with another search filter or custom\_view\_id.
>
> **converted** `string ("true" | "false" | "both")`
>
> Whether to count converted records: true, false, or both.
>
> **custom\_view\_id** `string`
>
> Custom view ID used to limit the count. Cannot be combined with criteria, email, phone, or word.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the module to count.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zoho CRM Automation Task
>
> **Slug:** `ZOHO_CREATE_AUTOMATION_TASK`
>
> Create an automation task with typed static, merge, date, or datetime mappings.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Display name of the task.
>
> **module** `object` *required*
>
> Module whose automation creates the task.
>
> **feature\_type** `string`
>
> Optional Zoho feature using this task definition. The only supported value is workflow.
>
> **field\_mappings** `array` *required*
>
> Mappings that populate fields in the created Tasks record. Use execution\_date for date fields and execution\_datetime for datetime fields; datetime mappings require a time of day.
>
> **related\_module** `object`
>
> Zoho CRM module identity used by an automation task.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact in Zoho CRM
>
> **Slug:** `ZOHO_CREATE_CONTACT`
>
> Creates a new contact record in Zoho CRM. Use this action when you need to add a new contact to the CRM system. The Last\_Name field is mandatory and must be provided with a non-empty value.
>
> #### Input Parameters
>
> **fax** `string`
>
> Fax number of the contact
>
> **email** `string`
>
> Email address of the contact
>
> **owner** `object`
>
> Reference to another contact or user in Zoho CRM.
>
> **phone** `string`
>
> Phone number of the contact
>
> **title** `string`
>
> Job title of the contact
>
> **lar\_id** `string`
>
> Assignment rule ID. Kept as a string to preserve Zoho's 19-digit IDs safely.
>
> **mobile** `string`
>
> Mobile phone number of the contact
>
> **trigger** `array`
>
> Automation triggers to execute during creation.
>
> **twitter** `string`
>
> Twitter handle of the contact
>
> **skype\_id** `string`
>
> Skype ID of the contact
>
> **assistant** `string`
>
> Name of the contact's assistant
>
> **last\_name** `string` *required*
>
> Last name of the contact (required field, must be non-empty)
>
> **other\_zip** `string`
>
> ZIP code for other address
>
> **asst\_phone** `string`
>
> Phone number of the contact's assistant
>
> **department** `string`
>
> Department where the contact works
>
> **first\_name** `string`
>
> First name of the contact
>
> **home\_phone** `string`
>
> Home phone number of the contact
>
> **other\_city** `string`
>
> City for other address
>
> **description** `string`
>
> Description or notes about the contact
>
> **lead\_source** `string`
>
> Source from which the contact was acquired
>
> **mailing\_zip** `string`
>
> ZIP code for mailing address
>
> **other\_phone** `string`
>
> Alternative phone number of the contact
>
> **other\_state** `string`
>
> State for other address
>
> **vendor\_name** `string`
>
> Name of the vendor associated with this contact
>
> **account\_name** `string`
>
> Name of the account associated with this contact
>
> **mailing\_city** `string`
>
> City for mailing address
>
> **other\_street** `string`
>
> Street address for other address
>
> **reporting\_to** `object`
>
> Reference to another contact or user in Zoho CRM.
>
> **date\_of\_birth** `string`
>
> Date of birth of the contact in YYYY-MM-DD format
>
> **mailing\_state** `string`
>
> State for mailing address
>
> **other\_country** `string`
>
> Country for other address
>
> **mailing\_street** `string`
>
> Street address for mailing
>
> **mailing\_country** `string`
>
> Country for mailing address
>
> **secondary\_email** `string`
>
> Secondary email address of the contact
>
> **skip\_feature\_execution** `array`
>
> Features to skip during creation, such as cadences.
>
> **apply\_feature\_execution** `array`
>
> Features to execute during creation, such as layout\_rules or criteria\_validation\_rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zoho CRM Custom Fields
>
> **Slug:** `ZOHO_CREATE_CUSTOM_FIELD`
>
> Create one to five custom fields in a Zoho CRM module.
>
> #### Input Parameters
>
> **fields** `array` *required*
>
> One to five custom-field definitions. Select a data\_type variant to expose its required configuration; unknown top-level provider properties remain accepted for API evolution.
>
> **module\_api\_name** `string` *required*
>
> Required exact API name of the module that will receive the custom fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zoho CRM Custom View
>
> **Slug:** `ZOHO_CREATE_CUSTOM_VIEW`
>
> Create one custom view for a Zoho CRM module.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the custom view.
>
> **fields** `array` *required*
>
> One to 250 fields displayed in the custom view, with optional pin, pixel-width, and pin-order configuration.
>
> **locked** `boolean`
>
> Whether the custom view is locked.
>
> **sort\_by** `object`
>
> Field reference used to sort the custom view, or null for no sort.
>
> **category** `string ("public_views" | "other_users_views" | "shared_with_me" | "created_by_me")`
>
> Documented category used to organize the custom view.
>
> **criteria** `string`
>
> A typed field criterion or nested group. Pass null to return all records.
>
> **favorite** `integer`
>
> Favorite order, or null to leave the view out of favorites.
>
> **shared\_to** `array`
>
> Users, roles, groups, or territories that can access a shared view.
>
> **wrap\_text** `boolean`
>
> Whether text wrapping is enabled for the custom view.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort direction, or null for no sort order.
>
> **access\_type** `string ("shared" | "public" | "only_to_me")` *required*
>
> Who can access the custom view.
>
> **cross\_filters** `array`
>
> Up to three filters over records in related modules.
>
> **module\_api\_name** `string` *required*
>
> API name of the Zoho CRM module that will own the custom view.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Deal in Zoho CRM
>
> **Slug:** `ZOHO_CREATE_DEAL`
>
> Creates a new deal in Zoho CRM representing a sales opportunity with deal name, stage, amount, and closing date. Use this action when you need to create a sales deal or opportunity in Zoho CRM. Required fields are Deal\_Name and Stage; all other fields are optional. The deal will be assigned to the authenticated user unless an Owner is explicitly specified.
>
> #### Input Parameters
>
> **Owner** `object`
>
> Owner of the deal.
>
> **Stage** `string` *required*
>
> The current stage of the deal in the sales pipeline. This is a required field. Common stages include: 'Qualification', 'Needs Analysis', 'Value Proposition', 'Proposal/Price Quote', 'Negotiation/Review', 'Closed Won', 'Closed Lost'.
>
> **Amount** `number`
>
> The monetary value of the deal in the account's currency. Use decimal format for fractional amounts.
>
> **lar\_id** `string`
>
> Assignment rule ID. Kept as a string to preserve Zoho's 19-digit IDs safely.
>
> **trigger** `array`
>
> Automation triggers to execute during creation.
>
> **Pipeline** `string`
>
> The sales pipeline this deal belongs to. Required when multiple pipelines are enabled in your Zoho CRM org. Use the exact pipeline name as configured in Zoho CRM.
>
> **Deal\_Name** `string` *required*
>
> The name of the deal. This is a required field and must be a non-empty string.
>
> **Next\_Step** `string`
>
> The next action or step planned for moving this deal forward in the sales process.
>
> **Description** `string`
>
> A detailed description or notes about the deal, including context, requirements, or special considerations.
>
> **Lead\_Source** `string`
>
> The source or channel from which this deal originated.
>
> **Probability** `integer`
>
> The probability of closing this deal, expressed as a percentage between 0 and 100.
>
> **Account\_Name** `object`
>
> Account associated with the deal.
>
> **Closing\_Date** `string`
>
> The expected or actual closing date of the deal in YYYY-MM-DD format (ISO 8601 date format).
>
> **Contact\_Name** `object`
>
> Contact associated with the deal.
>
> **Campaign\_Source** `object`
>
> Campaign associated with the deal.
>
> **skip\_feature\_execution** `array`
>
> Features to skip during creation, such as cadences.
>
> **apply\_feature\_execution** `array`
>
> Features to execute during creation, such as layout\_rules or criteria\_validation\_rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Email Draft in Zoho CRM
>
> **Slug:** `ZOHO_CREATE_EMAIL_DRAFT`
>
> Creates email drafts for a specific record in Zoho CRM. Email drafts are saved but not sent, allowing for review and editing before sending. Use this action when you need to prepare email communications associated with CRM records (Leads, Contacts, Deals, etc.) that will be reviewed and sent later. The draft will be visible in the record's timeline and can be edited or sent through the Zoho CRM interface.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Unique identifier of the record for which to create the email draft
>
> **email\_drafts** `array` *required*
>
> List of email drafts to create (maximum 100 drafts per API call). Each draft must include 'from' and 'rich\_text' fields. Use this action when you need to create draft emails associated with a CRM record for later review and sending.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module containing the record for which to create the email draft. Standard modules include 'Leads', 'Contacts', 'Accounts', 'Deals', 'Quotes', 'Sales\_Orders', 'Purchase\_Orders', 'Cases'. Custom modules must use their exact API name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zoho Event
>
> **Slug:** `ZOHO_CREATE_EVENT`
>
> Creates a new Event record in Zoho CRM. Events represent scheduled activities like meetings, calls, or appointments. Use this action when you need to schedule a new event or meeting in the CRM system. All events require an event title, start time, and end time at minimum.
>
> #### Input Parameters
>
> **Owner** `object`
>
> Reference to another record in the CRM.
>
> **Venue** `string`
>
> Location or venue of the event
>
> **Who\_Id** `object`
>
> Contact associated with the event; relate Leads through What\_Id instead.
>
> **All\_day** `boolean`
>
> Indicates whether the event spans an entire day or multiple days
>
> **What\_Id** `object`
>
> Reference to a business record related to the event.
>
> **trigger** `array`
>
> List of supported automation triggers to invoke. Use cautiously because triggers can cause side effects such as sending emails.
>
> **Remind\_At** `array`
>
> List of reminder configurations for the event. Each reminder specifies when to alert before the event starts
>
> **Description** `string`
>
> Detailed description of the event
>
> **Event\_Title** `string` *required*
>
> Name of the event. Required field that accepts alphanumeric and special characters
>
> **End\_DateTime** `string` *required*
>
> Event end date and time in ISO8601 format (e.g., '2024-07-03T14:30:00+05:30')
>
> **Participants** `array`
>
> List of event participants (leads, contacts, users, or email addresses)
>
> **Start\_DateTime** `string` *required*
>
> Event start date and time in ISO8601 format (e.g., '2024-07-03T12:30:00+05:30')
>
> **Check\_In\_Status** `string`
>
> Check-in status for the event
>
> **Recurring\_Activity** `object`
>
> Recurrence rule for the event in RRULE format.
>
> **skip\_feature\_execution** `array`
>
> Features to skip during creation, such as cadences.
>
> **apply\_feature\_execution** `array`
>
> Features to execute during creation, such as layout\_rules or criteria\_validation\_rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zoho CRM Function
>
> **Slug:** `ZOHO_CREATE_FUNCTION`
>
> Create a Zoho CRM function. Deluge code is optional and auto-published. Java, Node.js, and Python require a ZIP package and remain drafts unless publish\_changelog requests publication.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Function display name. Must start with a letter and contain only letters, digits, spaces, hyphens, and underscores (3-100 characters).
>
> **runtime** `string ("Deluge 1.0" | "Java 8" | "Java 17" | "NodeJS 8" | "NodeJS 22" | "Python 3.12")` *required*
>
> Runtime: Deluge 1.0, Java 8, Java 17, NodeJS 8, NodeJS 22, or Python 3.12.
>
> **api\_name** `string` *required*
>
> Unique function API name. Must start with a letter and contain only letters, digits, hyphens, and underscores (3-100 characters).
>
> **category** `string ("Button" | "Automation" | "Schedule" | "Related List" | "Standalone" | "Signals" | "Validation Rule")` *required*
>
> Function category supported by the selected runtime: Button, Automation, Schedule, Related List, Standalone, Signals, or Validation Rule.
>
> **code\_file** `object`
>
> Implementation file, up to 25 MB. For Deluge it is optional, must be .ds, and is auto-published. Java, Node.js, and Python require a valid ZIP and remain drafts unless publish\_changelog requests publication. A ZIP may have at most 10,000 entries, each up to 25 MB uncompressed and 100 MB uncompressed in aggregate. Its full name is at most 255 characters; its ASCII-alphanumeric basename must be account-wide unique. For compiled runtimes, function name, ZIP basename, and main source basename must match case-sensitively. Put config.json and the matching .java, .js, or .py source at ZIP root or in one top-level folder. lib/ for Java/Python and node\_modules/ for Node.js are optional.
>
> **deluge\_code** `string`
>
> Optional complete Deluge function definition for Deluge 1.0. Its declaration must use the category and function name in lowercase with spaces replaced by underscores, and a return type allowed for the category. Deluge code is automatically published.
>
> **description** `string`
>
> Optional function description, up to 3000 characters.
>
> **publish\_changelog** `string`
>
> For Java, Node.js, and Python, requests publication after creation and records this changelog if publication succeeds; without it the function remains a draft. For Deluge, records the changelog for the automatically published revision.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Lead in Zoho CRM
>
> **Slug:** `ZOHO_CREATE_LEAD`
>
> Creates a new lead record in Zoho CRM with the specified details. The only mandatory field is Last\_Name - all other fields are optional. Use this action when you need to add a new lead to Zoho CRM, typically after capturing lead information from a web form, email, or other lead generation source. The action returns the newly created lead ID and metadata including creation timestamps and user information.
>
> #### Input Parameters
>
> **Fax** `string`
>
> Fax number of the lead
>
> **City** `string`
>
> City of the lead's address
>
> **Email** `string`
>
> Email address of the lead
>
> **Phone** `string`
>
> Phone number of the lead (up to 30 characters)
>
> **State** `string`
>
> State or province of the lead's address
>
> **Mobile** `string`
>
> Mobile phone number of the lead
>
> **Rating** `string`
>
> Rating of the lead (e.g., Acquired, Active, Market Failed, Project Cancelled, Shutdown)
>
> **Street** `string`
>
> Street address of the lead
>
> **lar\_id** `string`
>
> Lead assignment rule ID to apply when creating the lead. This determines which user the lead will be assigned to based on predefined rules
>
> **Company** `string`
>
> Company name associated with the lead
>
> **Country** `string`
>
> Country of the lead's address
>
> **Twitter** `string`
>
> Twitter handle of the lead
>
> **Website** `string`
>
> Website URL of the lead's company
>
> **trigger** `array`
>
> List of supported automation triggers to execute during lead creation. Use this only when explicitly needed because triggers can send emails or modify other records.
>
> **Industry** `string`
>
> Industry sector of the lead's company
>
> **Skype\_ID** `string`
>
> Skype ID of the lead
>
> **Zip\_Code** `string`
>
> Postal or ZIP code of the lead's address
>
> **Last\_Name** `string` *required*
>
> Last name of the lead - this is a mandatory field in Zoho CRM
>
> **First\_Name** `string`
>
> First name of the lead
>
> **Salutation** `string`
>
> Salutation or title for the lead (e.g., Mr., Ms., Dr., Prof.)
>
> **Description** `string`
>
> Additional notes or description about the lead
>
> **Designation** `string`
>
> Job title or designation of the lead
>
> **Lead\_Source** `string`
>
> Source from which the lead was acquired (e.g., Advertisement, Cold Call, Employee Referral, External Referral, Online Store, Partner, Public Relations, Sales Email Alias, Seminar Partner, Internal Seminar, Trade Show, Web Download, Web Research, Chat)
>
> **Lead\_Status** `string`
>
> Current status of the lead (e.g., Attempted to Contact, Contact in Future, Contacted, Junk Lead, Lost Lead, Not Contacted, Pre-Qualified, Not Qualified)
>
> **Annual\_Revenue** `number`
>
> Annual revenue of the lead's company
>
> **No\_of\_Employees** `integer`
>
> Number of employees in the lead's company
>
> **Secondary\_Email** `string`
>
> Secondary email address of the lead
>
> **skip\_feature\_execution** `array`
>
> Features to skip during creation, such as cadences.
>
> **apply\_feature\_execution** `array`
>
> Features to execute during creation, such as layout\_rules or criteria\_validation\_rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Note in Zoho CRM
>
> **Slug:** `ZOHO_CREATE_NOTE`
>
> Creates a new note attached to a specific record in Zoho CRM. Notes are text annotations that can be added to any standard or custom module record. Use this action when you need to add notes, comments, or text-based documentation to a record in Zoho CRM. The note will be visible in the record's Notes related list.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> The unique identifier of the parent record to attach the note to. This is the ID of the record in the specified module.
>
> **Note\_Title** `string`
>
> Optional title for the note
>
> **Note\_Content** `string` *required*
>
> The content/text of the note (required)
>
> **module\_api\_name** `string` *required*
>
> The API name of the parent module containing the record. Examples: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', etc. This must be a valid module API name in Zoho CRM.
>
> **is\_shared\_to\_client** `boolean`
>
> Whether the note is shared with the client.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zoho CRM Workflow Rule
>
> **Slug:** `ZOHO_CREATE_WORKFLOW_RULE`
>
> Create one Zoho CRM workflow rule with typed triggers, criteria, and actions.
>
> #### Input Parameters
>
> **workflow\_rule** `object` *required*
>
> The one workflow rule to create in this request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zoho CRM Record
>
> **Slug:** `ZOHO_CREATE_ZOHO_RECORD`
>
> Creates new records in a specified Zoho CRM module. Bulk operations may partially succeed; an item failure raises an error even when other records were created.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> A list of dictionaries representing the records to be created. Each dictionary contains field API names as keys and their values. Required fields depend on the module (e.g., Last\_Name is required for Leads and Contacts, and MUST have a non-empty value). For lookup fields, use simplified format: \{"id": "\<record\_id>", "module": "\<ModuleName>"} (e.g., \{"id": "123456", "module": "Accounts"}) or full API format for Parent\_Id: \{"id": "\<record\_id>", "module": \{"api\_name": "\<ModuleName>"}}. IMPORTANT: What\_Id is for business objects (Accounts, Deals, Products, Quotes, Sales\_Orders, Purchase\_Orders, Invoices, Campaigns, Vendors, Cases, Leads). Who\_Id is for Contacts. Relate activities to Leads through What\_Id with module 'Leads'. To assign an owner, use the field "Owner" with a valid Zoho user ID dict (e.g., \{"id": "\<user\_id>"}); incorrect field names silently fail to assign ownership. For Tasks, include only minimal required fields — extra layout-dependent fields can cause INVALID\_DATA errors.
>
> **lar\_id** `string`
>
> Assignment rule ID to apply when creating records. Kept as a string to preserve Zoho's 19-digit IDs safely.
>
> **trigger** `array`
>
> List of supported automation triggers to invoke during record creation. Enabling triggers can cause side effects (emails sent, other records modified), so only include them when explicitly desired.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module to create a record in. Standard modules use PascalCase (e.g., 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', 'Campaigns'). Custom modules must use their exact API name as configured in Zoho CRM - this is NOT the display name. To find a custom module's API name: Go to Setup > Developer Hub > APIs and SDKs > API Names, then select the custom module from the dropdown. The API name is typically in the format 'CustomModule1', 'CustomModule2', etc., or a name assigned when the module was created.
>
> **skip\_feature\_execution** `array`
>
> Features to skip during creation, such as cadences.
>
> **apply\_feature\_execution** `array`
>
> Features to execute during creation, such as layout\_rules or criteria\_validation\_rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Zoho CRM Tag
>
> **Slug:** `ZOHO_CREATE_ZOHO_TAG`
>
> Creates a new tag in Zoho CRM for a specific module. Tags help organize and categorize CRM records. Each module can have up to 100 tags, and each record can have up to 10 tags assigned. Tags must have unique names within a module and can be assigned custom colors from a predefined palette. Creating a tag does not apply it to any records; use separate update actions to assign the tag to records. Use this action to create standardized tags for lead scoring, deal stages, customer segments, or any custom categorization needs in your CRM workflow.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> The name of the tag to create. Maximum 25 characters. Cannot contain '\<', '>', commas, or emojis.
>
> **color\_code** `string`
>
> Hex color code for the tag. Must be one of the 13 allowed colors: #F17574 (red), #F48435 (orange), #E7A826 (yellow), #A8C026 (lime), #63C57E (green), #1DB9B4 (teal), #57B1FD (blue), #879BFC (indigo), #D297EE (purple), #FD87BD (pink), #969696 (gray), #658BA8 (slate), #B88562 (brown). Defaults to orange (#F48435).
>
> **module\_api\_name** `string` *required*
>
> The API name of the Zoho CRM module to create the tag in. Supported modules: Leads, Accounts, Contacts, Deals, Campaigns, Tasks, Cases, Events, Calls, Solutions, Products, Vendors, Price Books, Quotes, Sales Orders, Purchase Orders, Invoices, and custom modules. Value is case-sensitive and must exactly match the CRM API name (e.g., 'Leads' not 'leads' or 'Lead').
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho Account
>
> **Slug:** `ZOHO_DELETE_ACCOUNT`
>
> Deletes an existing account record from Zoho CRM. This action permanently removes the account and cannot be undone through the API. Use this action when you need to remove an account record that is no longer needed or was created in error. This action is irreversible — the account cannot be recovered once deleted.
>
> #### Input Parameters
>
> **account\_id** `string` *required*
>
> The unique identifier of the account to delete. Must be a valid Zoho CRM account ID.
>
> **wf\_trigger** `boolean`
>
> Whether to trigger workflow rules during deletion. Set to true to execute workflows, false to skip them. If not specified, default behavior applies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho CRM Contact
>
> **Slug:** `ZOHO_DELETE_CONTACT`
>
> Deletes a contact from Zoho CRM by its ID, with an optional workflow trigger setting.
>
> #### Input Parameters
>
> **contact\_id** `string` *required*
>
> The unique identifier of the contact to delete
>
> **wf\_trigger** `boolean`
>
> Whether to trigger workflows during deletion. If true, all associated workflows execute. Defaults to true if not specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho CRM Deal
>
> **Slug:** `ZOHO_DELETE_DEAL`
>
> Deletes a deal record from Zoho CRM. This action is irreversible — once deleted, the deal cannot be recovered. Use this action when you need to permanently remove a deal from the CRM system. The deal will be moved to the recycle bin initially and can be restored from there within the configured retention period (typically 60 days), after which permanent deletion occurs automatically.
>
> #### Input Parameters
>
> **deal\_id** `string` *required*
>
> The unique identifier of the deal to delete. This is the Zoho CRM record ID for the deal
>
> **wf\_trigger** `boolean`
>
> Whether to trigger workflow rules after deletion. Set to true to execute workflows, or false to skip them. When workflows execute, side effects like notifications and automations may occur
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho CRM Email Draft
>
> **Slug:** `ZOHO_DELETE_EMAIL_DRAFT`
>
> Delete one unsent email draft associated with a Zoho CRM record.
>
> #### Input Parameters
>
> **draft\_id** `string` *required*
>
> Unique identifier of the email draft to delete.
>
> **record\_id** `string` *required*
>
> Unique identifier of the record containing the draft.
>
> **module\_api\_name** `string` *required*
>
> API name of the module containing the record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho CRM Event
>
> **Slug:** `ZOHO_DELETE_EVENT`
>
> Move one Zoho CRM Event record to the recycle bin. Omitting wf\_trigger uses Zoho's default of true, so workflows and notifications can run.
>
> #### Input Parameters
>
> **event\_id** `string` *required*
>
> The unique Zoho CRM record ID of the event to delete.
>
> **wf\_trigger** `boolean`
>
> Whether to execute workflow rules during deletion. Zoho defaults an omitted value to true, so workflows and notifications can run.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho CRM Lead
>
> **Slug:** `ZOHO_DELETE_LEAD`
>
> Move one Zoho CRM Lead record to the recycle bin.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> The unique Zoho CRM record ID of the lead to delete.
>
> **wf\_trigger** `boolean`
>
> Whether to execute workflow rules during deletion. If omitted, Zoho's default behavior applies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho CRM Note
>
> **Slug:** `ZOHO_DELETE_NOTE`
>
> Move one Zoho CRM note to the recycle bin.
>
> #### Input Parameters
>
> **note\_id** `string` *required*
>
> The unique Zoho CRM record ID of the note to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho CRM Records
>
> **Slug:** `ZOHO_DELETE_RECORDS`
>
> Move up to 100 records from a Zoho CRM module to the recycle bin.
>
> #### Input Parameters
>
> **record\_ids** `array` *required*
>
> The IDs of 1 to 100 records to move to the recycle bin.
>
> **wf\_trigger** `boolean`
>
> Whether to execute workflow rules during deletion. If omitted, Zoho's default behavior applies.
>
> **module\_api\_name** `string` *required*
>
> The API name of the standard or custom Zoho CRM module containing the records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Zoho CRM Tag
>
> **Slug:** `ZOHO_DELETE_TAG`
>
> Delete one Zoho CRM tag definition by its tag ID.
>
> #### Input Parameters
>
> **tag\_id** `string` *required*
>
> The unique ID of the Zoho CRM tag definition to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Zoho CRM Record Attachment
>
> **Slug:** `ZOHO_DOWNLOAD_RECORD_ATTACHMENT`
>
> Download one attachment from a Zoho CRM record as a file.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Unique ID of the Zoho CRM record containing the attachment.
>
> **attachment\_id** `string` *required*
>
> Unique attachment ID returned by ZOHO\_LIST\_RECORD\_ATTACHMENTS or ZOHO\_UPLOAD\_ATTACHMENT.
>
> **module\_api\_name** `string` *required*
>
> API name of the module containing the record, such as Leads, Contacts, Accounts, or Deals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Zoho CRM Record Email Attachment
>
> **Slug:** `ZOHO_DOWNLOAD_RECORD_EMAIL_ATTACHMENT`
>
> Download one attachment from an email associated with a CRM record.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Attachment name exactly as returned in the email's attachments array.
>
> **user\_id** `string` *required*
>
> Unique ID of the Zoho CRM user who sent the email.
>
> **record\_id** `string` *required*
>
> Unique ID of the Zoho CRM record associated with the email.
>
> **message\_id** `string` *required*
>
> Message ID returned by the send-mail or record-email retrieval action.
>
> **attachment\_id** `string` *required*
>
> Unique attachment ID from the attachments array returned for the email. This is sent as Zoho's `id` query parameter.
>
> **module\_api\_name** `string` *required*
>
> API name of the module containing the record, such as Leads, Contacts, Accounts, or Deals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Zoho CRM Record Photo
>
> **Slug:** `ZOHO_DOWNLOAD_RECORD_PHOTO`
>
> Download the binary profile photo attached to a supported CRM record.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Unique ID of the Zoho CRM record whose profile photo to download.
>
> **module\_api\_name** `string` *required*
>
> Supported Zoho CRM module API name containing the record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Export Zoho CRM Audit Logs
>
> **Slug:** `ZOHO_EXPORT_AUDIT_LOGS`
>
> Export Zoho CRM audit logs and return the completed CSV or ZIP file.
>
> #### Input Parameters
>
> **criteria** `string`
>
> Optional documented audit-log filter. Omit it to export up to the last three years of audit logs across all modules.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Account
>
> **Slug:** `ZOHO_GET_ACCOUNT`
>
> Retrieves a specific Zoho CRM Account record by its unique identifier, with optional field selection. Single-record responses can provide access to subform records, multi-select lookup fields, and multi-user lookup fields.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated API names of fields to retrieve (max 50 fields). If not specified, all available fields for the account are returned. Common fields: Account\_Name, Website, Phone, Email, Industry, Annual\_Revenue, Billing\_Street, Billing\_City, Billing\_State, Billing\_Country, Owner. Note: Subform records, multi-select lookup fields, and multi-user lookup fields are only accessible when fetching a specific record (not available in list operations).
>
> **account\_id** `string` *required*
>
> The unique identifier of the Account record to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Assignment Rule
>
> **Slug:** `ZOHO_GET_ASSIGNMENT_RULE`
>
> Retrieve one assignment rule and its module-specific configuration.
>
> #### Input Parameters
>
> **module** `string` *required*
>
> API name of the CRM module that owns the assignment rule.
>
> **assignment\_rule\_id** `string` *required*
>
> Unique numeric ID of the assignment rule to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Automation Task
>
> **Slug:** `ZOHO_GET_AUTOMATION_TASK`
>
> Retrieve one configured Zoho CRM automation task and its field mappings.
>
> #### Input Parameters
>
> **task\_id** `string` *required*
>
> Unique ID of the configured Zoho CRM automation task.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Blueprint
>
> **Slug:** `ZOHO_GET_BLUEPRINT`
>
> Retrieve one Zoho CRM blueprint and optional configuration details.
>
> #### Input Parameters
>
> **include** `string ("state" | "transition")`
>
> Additional blueprint configuration to include: state for states or transition for transitions.
>
> **blueprint\_id** `string` *required*
>
> The unique ID of the Zoho CRM blueprint to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Blueprint Transition
>
> **Slug:** `ZOHO_GET_BLUEPRINT_TRANSITION`
>
> Retrieve one Zoho CRM blueprint transition and its configuration.
>
> #### Input Parameters
>
> **transition\_id** `string` *required*
>
> Unique ID of the Zoho CRM blueprint transition to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Call
>
> **Slug:** `ZOHO_GET_CALL`
>
> Retrieves a specific Call record by its unique identifier from Zoho CRM. Use this action when you need to fetch detailed information about a particular call, including its subject, duration, type, participants, outcome, and associated contacts or deals. This action is read-only and does not modify any data.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated API names of specific fields to retrieve (max 50). If not specified, all standard fields are returned. Common fields: Subject, Call\_Type, Call\_Start\_Time, Call\_Duration, Call\_Purpose, Call\_Agenda, Call\_Result, Description, Owner, Who\_Id, What\_Id, Created\_Time, Modified\_Time. Use field API names exactly as they appear in Zoho CRM.
>
> **record\_id** `string` *required*
>
> The unique identifier of the Call record to retrieve. Must be a valid Zoho CRM record ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Contact
>
> **Slug:** `ZOHO_GET_CONTACT`
>
> Retrieves a single Zoho CRM contact record by ID, optionally selecting fields by their API names. Contact details may include owner information, account associations, address fields, and custom fields.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated field API names to include in the response.
>
> **record\_id** `string` *required*
>
> The unique ID of the contact record to retrieve. Must be a valid Zoho CRM contact record ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Custom Views
>
> **Slug:** `ZOHO_GET_CUSTOM_VIEWS`
>
> List custom views for a Zoho CRM module or inspect one view by ID.
>
> #### Input Parameters
>
> **custom\_view\_id** `string`
>
> The unique ID of one custom view. Omit this value to list all custom views for the module.
>
> **module\_api\_name** `string` *required*
>
> The API name of the Zoho CRM module whose custom views should be retrieved, such as Leads, Contacts, or a custom module API name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Deal
>
> **Slug:** `ZOHO_GET_DEAL`
>
> Retrieve one Zoho CRM Deal by record ID without a field projection.
>
> #### Input Parameters
>
> **deal\_id** `string` *required*
>
> Unique ID of the Zoho CRM Deal record to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Drafts for Zoho CRM Record
>
> **Slug:** `ZOHO_GET_EMAIL_DRAFTS`
>
> Retrieves email drafts associated with a specific record in Zoho CRM. Use this action when you need to view unsent email drafts that have been composed for a CRM record. This returns draft metadata including recipients, subject, attachments, and scheduling details; content and summary may be null.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve when listing drafts. Starts at 1.
>
> **module** `string` *required*
>
> The API name of the CRM module containing the record. Examples: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Cases', etc. Must be the exact module API name, not the UI display label.
>
> **record** `string` *required*
>
> Entity ID of the record for which to retrieve email drafts.
>
> **draft\_id** `string`
>
> Unique email draft ID to retrieve. When provided, pagination parameters are ignored and only this draft is returned.
>
> **per\_page** `integer`
>
> Number of drafts to retrieve per collection page, from 1 to 10.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho Event
>
> **Slug:** `ZOHO_GET_EVENT`
>
> Retrieves a specific Zoho CRM event or meeting by its unique identifier, optionally selecting fields. Use it to fetch event details such as timing, location, participants, and related records.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated field API names to include in the response.
>
> **record\_id** `string` *required*
>
> The unique identifier of the event record to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get From Addresses
>
> **Slug:** `ZOHO_GET_FROM_ADDRESSES`
>
> Retrieves the list of from addresses configured for email operations in Zoho CRM. Use this action when you need to get available email addresses for sending emails or configuring email settings. Returns the available primary, IMAP, and organization email addresses configured in the CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Kiosk States
>
> **Slug:** `ZOHO_GET_KIOSK_STATES`
>
> List a kiosk's states or retrieve one state and its associated elements.
>
> #### Input Parameters
>
> **kiosk\_id** `string` *required*
>
> Unique ID of the Zoho CRM kiosk.
>
> **state\_id** `string`
>
> Unique state ID. Omit to list all states in the kiosk.
>
> **include\_configured\_properties** `boolean`
>
> Whether list results should include configured merge-field properties. This option is ignored when state\_id is provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Layouts
>
> **Slug:** `ZOHO_GET_LAYOUTS`
>
> List layouts for a CRM module or retrieve one complete layout definition.
>
> #### Input Parameters
>
> **layout\_id** `string`
>
> Unique layout ID. Omit to list all layouts for the module.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the CRM module whose layouts to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Module Fields Metadata
>
> **Slug:** `ZOHO_GET_MODULE_FIELDS`
>
> Retrieves field metadata for a Zoho CRM module including API names, data types, permissions, and configuration details. Use this tool to discover correct field names and types before creating or updating records, avoiding INVALID\_DATA errors. Returns information about standard fields, custom fields, lookup fields, picklist options, and field-level permissions.
>
> #### Input Parameters
>
> **type** `string ("all" | "unused")`
>
> Filter fields by usage type. Values: 'all' (both used and unused fields) or 'unused' (unused fields only). If not specified, returns all used fields.
>
> **include** `string`
>
> Include additional permission details in the response. Use 'allowed\_permissions\_to\_update' to get default field permissions (read-only, read-write, hidden).
>
> **field\_unique\_id** `string`
>
> The unique ID of a specific field to retrieve. When provided, only that single field's metadata is returned. If not specified, all fields for the module are returned.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module to retrieve field metadata for. Examples: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', 'Cases', 'Events', 'Calls', etc. For custom modules, use the exact API name as configured in Zoho CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Note
>
> **Slug:** `ZOHO_GET_NOTE`
>
> Retrieves a single Zoho CRM note by its unique identifier, with a selectable set of fields. The default fields include the note's title, content, parent record reference, owner details, and timestamps.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated API names of the fields to retrieve. Common fields: Note\_Title, Note\_Content, Parent\_Id, Owner, Created\_Time, Modified\_Time, Created\_By, Modified\_By. This parameter is required by the Zoho API.
>
> **note\_id** `string` *required*
>
> The unique identifier of the note to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Organization Details
>
> **Slug:** `ZOHO_GET_ORGANIZATION_DETAILS`
>
> Retrieve identity, locale, currency, contact, and license metadata for the connected Zoho CRM organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Pipelines
>
> **Slug:** `ZOHO_GET_PIPELINES`
>
> Retrieve pipeline and stage configuration for a Zoho CRM Deals layout.
>
> #### Input Parameters
>
> **layout\_id** `string` *required*
>
> Unique numeric ID of the Zoho CRM Deals layout.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Product
>
> **Slug:** `ZOHO_GET_PRODUCT`
>
> Retrieve one Zoho CRM Product by record ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated API names of Product fields to retrieve. Omit this value to retrieve all available fields.
>
> **record\_id** `string` *required*
>
> The unique ID of the Zoho CRM Product record to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Profile
>
> **Slug:** `ZOHO_GET_PROFILE`
>
> Retrieve one Zoho CRM permission profile and its expanded permissions.
>
> #### Input Parameters
>
> **profile\_id** `string` *required*
>
> Unique Zoho CRM permission profile ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Record
>
> **Slug:** `ZOHO_GET_RECORD`
>
> Retrieve one record from a standard or custom Zoho CRM module by ID. Use this generic action for custom modules and standard modules without a dedicated getter. Zoho truncates rich-text fields to 500 characters; use its Rich Text Fields API when full rich-text content is required.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated API names of fields to retrieve. Omit to let Zoho return all fields available through this endpoint.
>
> **record\_id** `string` *required*
>
> Unique ID of the record in the selected module.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the standard or custom CRM module.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Record Email
>
> **Slug:** `ZOHO_GET_RECORD_EMAIL`
>
> Retrieve one email associated with a Zoho CRM record, including its body.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> ID of the email owner. Required when viewing another user's shared email; omit when viewing your own email.
>
> **record\_id** `string` *required*
>
> Unique ID of the CRM record related to the email.
>
> **message\_id** `string` *required*
>
> Message ID returned by the record email collection action.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the module containing the related record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Record Emails
>
> **Slug:** `ZOHO_GET_RECORD_EMAILS`
>
> Retrieves a page of emails associated with a specific record in Zoho CRM. Use this action when you need to fetch email history for a lead, contact, account, deal, or other CRM record. The response includes email metadata such as subject, sender, recipients, timestamps, and status information. Supports pagination for records with large email volumes.
>
> #### Input Parameters
>
> **type** `string ("sent_from_crm" | "scheduled_in_crm" | "drafts" | "user_emails" | "all_contacts_sent_crm_emails" | "all_contacts_scheduled_crm_emails" | "all_contacts_draft_crm_emails")`
>
> Type of emails to filter.
>
> **index** `string`
>
> Pagination control parameter. Use the 'next\_index' value from the previous response's info object to retrieve the next batch of emails. Start without this parameter to get the first page.
>
> **owner\_id** `string`
>
> The ID of the user whose emails you want to fetch. IMPORTANT: This parameter can only be used when type='user\_emails'. It will be ignored if type is set to any other value.
>
> **record\_id** `string` *required*
>
> The unique identifier of the record whose emails you want to retrieve.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module containing the record. Common modules: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Quotes', 'Invoices', 'Sales\_Orders', 'Purchase\_Orders', or custom modules. Must be the exact API name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Record Timeline
>
> **Slug:** `ZOHO_GET_RECORD_TIMELINE`
>
> Retrieve chronological field and related-record history for a Zoho CRM record.
>
> #### Input Parameters
>
> **filters** `object`
>
> Structured Zoho timeline filter object. It is encoded as compact JSON in the filters query parameter.
>
> **include** `string ("extension" | "type")`
>
> Additional timeline category to include in the response.
>
> **sort\_by** `string`
>
> Sort timeline entries by their audited timestamp.
>
> **per\_page** `integer`
>
> Number of timeline entries to return on the first page (1-200). Cannot be used with page\_token.
>
> **record\_id** `string` *required*
>
> Unique ID of the Zoho CRM record whose timeline to retrieve.
>
> **page\_token** `string`
>
> Token from info.next\_page\_token. When supplied, per\_page must be omitted.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the Zoho CRM module containing the record.
>
> **include\_inner\_details** `array`
>
> Additional field-history or actor details to include.
>
> **include\_timeline\_type** `string`
>
> Timeline type to include. The include parameter is required when this is supplied.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Related Lists Metadata
>
> **Slug:** `ZOHO_GET_RELATED_LISTS`
>
> Retrieves related list metadata for a Zoho CRM module to discover correct api\_name values. Use this before updating related records to avoid INVALID\_DATA errors from incorrect related\_list\_api\_name. Returns api\_name, display\_label, href, and other details for each related list available in the module.
>
> #### Input Parameters
>
> **layout\_id** `string`
>
> Optional layout ID to filter related lists by specific layout. If not specified, returns related lists for all layouts of the module.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module to retrieve related list metadata for. Examples: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', etc. This must be a valid module API name in Zoho CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Related Records
>
> **Slug:** `ZOHO_GET_RELATED_RECORDS`
>
> Fetch related-list records (e.g., Notes, Attachments, Emails) for a Zoho CRM parent record using related\_list\_api\_name. Use ZOHO\_GET\_RELATED\_LISTS first to discover the correct api\_name for the related list you want to access. Supports pagination for large result sets (up to 2,000 records with page/per\_page and up to Zoho's token-pagination limit with page\_token).
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated list of specific related record IDs to retrieve. Use this to fetch only certain related records instead of all related records. When continuing with page\_token, provide the same IDs used for the original request. Example: '4876876000000636001,4876876000000636002'
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Without page\_token, only the first 2,000 records are accessible using page/per\_page pagination. Maximum page number is floor(2000/per\_page). Do not use together with page\_token.
>
> **fields** `string` *required*
>
> Comma-separated API names of the fields to retrieve (required by Zoho for this API). Specify the field names from the related list module whose details you want to receive. Example: 'Note\_Title,Note\_Content,Created\_Time' for Notes. Field names vary by related list type - check module field definitions to ensure correct names.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting related records.
>
> **per\_page** `integer`
>
> Number of records per page (default and maximum: 200). Applies to both page and page\_token pagination.
>
> **converted** `string ("false" | "true" | "both")`
>
> Filter for converted status (applicable to certain related lists).
>
> **record\_id** `string` *required*
>
> The unique identifier of the parent record for which to retrieve related records. This is the ID of the record in the specified module.
>
> **page\_token** `string`
>
> Token-based pagination parameter to fetch records beyond the 2,000-record discrete limit. Use the info.next\_page\_token from the previous response. Cannot be used together with page. Repeat the original fields, per\_page, IDs, sort, and converted-filter values because Zoho binds the token to that query.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for related records.
>
> **module\_api\_name** `string` *required*
>
> The API name of the parent module containing the record. Examples: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', etc. This must be a valid module API name in Zoho CRM.
>
> **related\_list\_api\_name** `string` *required*
>
> The API name of the related list to retrieve (e.g., 'Notes', 'Attachments', 'Emails'). IMPORTANT: Use the ZOHO\_GET\_RELATED\_LISTS action first to discover the correct api\_name for the related list you want to access. Using an incorrect api\_name will result in INVALID\_DATA errors. Example values: 'Notes', 'Attachments', 'Activities', 'Emails', 'Campaigns', 'Products', 'Open\_Activities', 'Closed\_Activities', 'Invited\_Events'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Task
>
> **Slug:** `ZOHO_GET_TASK`
>
> Retrieves a specific Zoho CRM task by its unique record ID, with an optional selection of fields. The returned record may include standard and custom fields, subforms, and multi-user lookup fields.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated API names of the fields to retrieve (max 50). If not specified, all standard fields are returned. Common task fields: Subject, Description, Due\_Date, Status, Priority, Owner, Who\_Id, What\_Id, Created\_Time, Modified\_Time. Use field API names, not display labels.
>
> **record\_id** `string` *required*
>
> The unique identifier of the task to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM User
>
> **Slug:** `ZOHO_GET_USER`
>
> Retrieves a Zoho CRM user by ID, including name, email, role, profile, status, and preferences. Use 'me' as user\_id to retrieve the currently authenticated user through Zoho's CurrentUser listing; concrete user IDs are retrieved through the individual-user endpoint.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> The unique identifier of the user to retrieve. This can be the user's ID from the Zoho CRM system or the special value 'me' to retrieve the currently authenticated user's information.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Webform
>
> **Slug:** `ZOHO_GET_WEBFORM`
>
> Retrieve one configured Zoho CRM webform by ID.
>
> #### Input Parameters
>
> **to\_time** `string`
>
> Optional analytics range end in DD-MM-YYYY HH:MM:SS format.
>
> **from\_time** `string`
>
> Optional analytics range start in DD-MM-YYYY HH:MM:SS format.
>
> **webform\_id** `string` *required*
>
> Unique ID of the webform to retrieve.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the module that owns the webform.
>
> **include\_active\_user\_details** `boolean`
>
> Whether to include active-user inner details in the response.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Workflow Rule
>
> **Slug:** `ZOHO_GET_WORKFLOW_RULE`
>
> Retrieve one Zoho CRM workflow rule and its complete configuration.
>
> #### Input Parameters
>
> **workflow\_rule\_id** `string` *required*
>
> Unique ID of the Zoho CRM workflow rule to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Records
>
> **Slug:** `ZOHO_GET_ZOHO_RECORDS`
>
> Retrieves records from a specified module in Zoho CRM. Notes: - Discrete (page/per\_page) pagination is limited to the first 2,000 records. To retrieve records beyond this, use token-based pagination via page\_token from the previous response's info.next\_page\_token. - Do not use page together with page\_token. - You cannot use cvid together with sort\_by.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated record IDs to fetch specific records. When continuing with page\_token, provide the same IDs used for the original request.
>
> **cvid** `integer`
>
> Custom view ID to filter the records. Cannot be used together with sort\_by. When continuing with page\_token, provide the same cvid used for the original request.
>
> **page** `integer`
>
> Page number to retrieve. Without page\_token, only the first 2,000 records are accessible using page/per\_page. Maximum page number is floor(2000/per\_page). Do not use together with page\_token.
>
> **fields** `string` *required*
>
> Required comma-separated API names of the fields to retrieve (max 50). At least one field must be specified (empty string not allowed). Field names are module-specific; this action does not infer them from module metadata. Common fields: First\_Name, Last\_Name, Email, Phone, Mobile. For Leads: Company, Lead\_Status, Lead\_Source. For Accounts: Account\_Name, Website, Industry. For Contacts: Account\_Name, Mailing\_Street. For Deals: Deal\_Name, Amount, Stage, Closing\_Date. Invalid or cross-module field names silently produce missing columns rather than explicit errors.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting Zoho CRM records.
>
> **per\_page** `integer`
>
> Number of records per page (default and max is 200). Applies to both page and page\_token pagination.
>
> **converted** `string ("false" | "true" | "both")`
>
> Filter by conversion status: 'true', 'false', or 'both'.
>
> **page\_token** `string`
>
> Token-based pagination parameter to fetch records beyond the 2,000-record discrete limit. Use the info.next\_page\_token from the previous response. Cannot be used together with page. Repeat the original fields, per\_page, IDs, custom view, and sort values because Zoho binds the token to that query.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for records.
>
> **territory\_id** `string`
>
> Territory ID used to filter records, represented as a string.
>
> **include\_child** `boolean`
>
> Whether to include records from child territories when territory\_id is provided.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module to retrieve records from. Common supported modules: Leads, Contacts, Accounts, Deals, Tasks, Events, Calls, Products, Quotes, Sales\_Orders, Purchase\_Orders, Invoices, Campaigns, Vendors, Price\_Books, Cases, Solutions, Notes. IMPORTANT: 'Activities' is NOT a supported module - use 'Tasks', 'Events', or 'Calls' instead. Must be the exact API name, not the UI display label — mismatches silently return empty results instead of an error.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Zoho CRM Users
>
> **Slug:** `ZOHO_GET_ZOHO_USERS`
>
> Tool to retrieve users from Zoho CRM. Use when you need to fetch user information such as IDs, names, emails, roles, or status for setting Owner fields or performing user-related operations in CRM workflows.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated list of user IDs to retrieve specific users. Maximum of 100 user IDs can be specified at once.
>
> **page** `integer`
>
> Page number to retrieve for paginated results. Default is 1.
>
> **type** `string ("AllUsers" | "ActiveUsers" | "DeactiveUsers" | "ConfirmedUsers" | "NotConfirmedUsers" | "DeletedUsers" | "ActiveConfirmedUsers" | "AdminUsers" | "ActiveConfirmedAdmins" | "CurrentUser")`
>
> The type of users to retrieve. Supported values: 'AllUsers' (all users including inactive), 'ActiveUsers' (only active users), 'DeactiveUsers' (only deactivated users), 'ConfirmedUsers' (users who have confirmed their account), 'NotConfirmedUsers' (users who have not confirmed their account), 'DeletedUsers' (deleted users), 'ActiveConfirmedUsers' (active and confirmed users), 'AdminUsers' (users with admin privileges), 'ActiveConfirmedAdmins' (active confirmed admin users), 'CurrentUser' (the currently authenticated user). If not specified, returns all active confirmed users.
>
> **type\_\_s** `string`
>
> Portal user type to retrieve. Zoho currently supports 'Client Portal User'.
>
> **per\_page** `integer`
>
> Number of users to retrieve per page. Maximum is 200. Default is 200.
>
> **if\_modified\_since** `string`
>
> Retrieve users modified after this timestamp. Use ISO 8601 format (e.g., '2024-01-15T10:00:00+00:00'). This will be sent as the 'If-Modified-Since' header to the API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Access Settings
>
> **Slug:** `ZOHO_LIST_ACCESS_SETTINGS`
>
> List roles or permission profiles configured in Zoho CRM.
>
> #### Input Parameters
>
> **collection** `string ("roles" | "profiles")` *required*
>
> Access-settings collection to list: roles or profiles.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Accounts
>
> **Slug:** `ZOHO_LIST_ACCOUNTS`
>
> Retrieves a list of account records from Zoho CRM with pagination and filtering support. Use this action when you need to fetch multiple account records from the Accounts module, optionally filtered by territory, approval status, or custom views. Supports both discrete pagination (first 2,000 records) and token-based pagination for larger datasets.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated account record IDs to retrieve. When using page\_token, this must match the original query.
>
> **cvid** `integer`
>
> Custom view ID to filter the account records. Cannot be used together with sort\_by. When using page\_token, this must match the original query.
>
> **page** `integer`
>
> Page number to retrieve. Without page\_token, only the first 2,000 records are accessible using page/per\_page. Maximum page number is floor(2000/per\_page). Do not use together with page\_token.
>
> **fields** `string` *required*
>
> Comma-separated API names of the account fields to retrieve (max 50). This parameter is mandatory in Zoho CRM v8 API. Common fields: Account\_Name, Phone, Website, Industry, Annual\_Revenue, Owner, Rating, Account\_Type. Invalid field names silently produce missing columns rather than errors.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting Zoho CRM Accounts records.
>
> **approved** `string`
>
> Filter accounts by approval status: 'true' for approved, 'false' for not approved, 'both' for all.
>
> **per\_page** `integer`
>
> Number of account records per page (max is 200). Default is 25 to avoid token bloat.
>
> **page\_token** `string`
>
> Token-based pagination parameter to fetch account records beyond the 2,000-record discrete limit. Use the info.next\_page\_token from the previous response. Cannot be used together with page.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for Accounts records.
>
> **territory\_id** `string`
>
> Territory ID to filter accounts by territory assignment, represented as a string.
>
> **include\_child** `boolean`
>
> Whether to include accounts from child territories when territory\_id is specified.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Cadences
>
> **Slug:** `ZOHO_LIST_CADENCES`
>
> List Zoho CRM cadence definitions using optional filters.
>
> #### Input Parameters
>
> **name** `string`
>
> Cadence-name JSON filter expression using equal, not\_equal, contains, not\_contains, starts\_with, or ends\_with. The HTTP transport URL-encodes it.
>
> **page** `integer`
>
> Page number to retrieve from the cadence list.
>
> **active** `boolean`
>
> Whether to return only active or only inactive cadences.
>
> **fields** `string`
>
> Set to name to request only cadence names.
>
> **per\_page** `integer`
>
> Number of cadence records to retrieve per page.
>
> **module\_api\_name** `string`
>
> API name of the CRM module whose cadences should be returned, such as Leads, Contacts, Deals, Vendors, or a custom module API name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Calls
>
> **Slug:** `ZOHO_LIST_CALLS`
>
> Retrieves Call activity records from Zoho CRM with pagination support. Use this action when you need to list calls logged in the CRM, filter by custom views, or retrieve specific Call records by ID. Call records represent phone call activities associated with Contacts, Leads, or other CRM records.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated Call record IDs to fetch specific records. When using page\_token, this must match the original query.
>
> **cvid** `integer`
>
> Custom view ID to filter the Call records. Cannot be used together with sort\_by. When using page\_token, this must match the original query.
>
> **page** `integer`
>
> Page number to retrieve. Without page\_token, only the first 2,000 Call records are accessible using page/per\_page. Maximum page number is floor(2000/per\_page). Do not use together with page\_token.
>
> **fields** `string` *required*
>
> Comma-separated API names of Call fields to retrieve (max 50). Required parameter. Common Call fields: Subject, Call\_Type, Call\_Start\_Time, Call\_Duration, Call\_Purpose, Call\_Agenda, Call\_Result, Description, Owner, Who\_Id, What\_Id, Created\_Time, Modified\_Time. Use the Get Module Fields action to discover all available fields for the Calls module.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting Zoho CRM Call records.
>
> **per\_page** `integer`
>
> Number of Call records per page (maximum is 200). Applies to both page and page\_token pagination. Defaults to 25 for optimal response size.
>
> **page\_token** `string`
>
> Token-based pagination parameter to fetch Call records beyond the 2,000-record discrete limit. Use the info.next\_page\_token from the previous response. Cannot be used together with page.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for Call records.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Connected Workflow Rules
>
> **Slug:** `ZOHO_LIST_CONNECTED_WORKFLOW_RULES`
>
> List trigger conditions for a module's rules in a connected workflow.
>
> #### Input Parameters
>
> **module\_api\_name** `string` *required*
>
> API name of the CRM module whose connected-workflow rules to return.
>
> **connected\_workflow\_id** `string` *required*
>
> Unique ID of the connected workflow whose rules to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contacts
>
> **Slug:** `ZOHO_LIST_CONTACTS`
>
> Retrieves contact records from Zoho CRM with support for pagination, filtering, and sorting. Use this action when you need to fetch a list of contacts from Zoho CRM. This is a specialized action focused on the Contacts module with contact-specific field defaults and optimizations. For retrieving records from other modules, use the generic get\_records action instead.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated contact record IDs to fetch specific contacts. When using page\_token, this must match the original query.
>
> **cvid** `integer`
>
> Custom view ID to filter the contact records. Cannot be used together with sort\_by. When using page\_token, this must match the original query.
>
> **page** `integer`
>
> Page number to retrieve. Without page\_token, only the first 2,000 records are accessible using page/per\_page. Maximum page number is floor(2000/per\_page). Do not use together with page\_token.
>
> **fields** `string`
>
> Comma-separated API names of the contact fields to retrieve (max 50). At least one field must be specified (empty string not allowed). Common contact fields: First\_Name, Last\_Name, Email, Phone, Mobile, Account\_Name, Mailing\_Street, Title, Department, Lead\_Source, Created\_Time, Modified\_Time. Invalid field names silently produce missing columns rather than explicit errors.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting Zoho CRM contact records.
>
> **per\_page** `integer`
>
> Number of contact records per page. Maximum is 200. Applies to both page and page\_token pagination.
>
> **page\_token** `string`
>
> Token-based pagination parameter to fetch contacts beyond the 2,000-record discrete limit. Use the info.next\_page\_token from the previous response. Cannot be used together with page.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for contact records.
>
> **territory\_id** `string`
>
> Territory ID used to filter contacts, represented as a string.
>
> **include\_child** `boolean`
>
> Whether to include contacts from child territories when territory\_id is provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Deals
>
> **Slug:** `ZOHO_LIST_DEALS`
>
> Retrieves a list of deals from Zoho CRM with support for filtering, sorting, and pagination. Use this action when you need to fetch deal records from Zoho CRM, whether all deals or filtered by specific criteria. The action supports both discrete pagination (page/per\_page) for the first 2,000 deals and token-based pagination for larger datasets.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated deal IDs to fetch specific deals. When using page\_token, this must match the original query.
>
> **cvid** `integer`
>
> Custom view ID to filter the deals. Cannot be used together with sort\_by. When using page\_token, this must match the original query.
>
> **page** `integer`
>
> Page number to retrieve. Without page\_token, only the first 2,000 deals are accessible using page/per\_page. Maximum page number is floor(2000/per\_page). Do not use together with page\_token.
>
> **fields** `string`
>
> Comma-separated API names of the deal fields to retrieve (max 50). At least one field must be specified (empty string not allowed). Common deal fields: Deal\_Name, Amount, Stage, Closing\_Date, Account\_Name, Contact\_Name, Owner, Lead\_Source, Probability, Expected\_Revenue, Next\_Step, Type, Description. Invalid field names silently produce missing columns rather than explicit errors.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting Zoho CRM deals.
>
> **per\_page** `integer`
>
> Number of deals per page (default 25, max is 200). Applies to both page and page\_token pagination.
>
> **converted** `string ("false" | "true" | "both")`
>
> Filter by conversion status: 'true', 'false', or 'both'.
>
> **page\_token** `string`
>
> Token-based pagination parameter to fetch deals beyond the 2,000-record discrete limit. Use the info.next\_page\_token from the previous response. Cannot be used together with page.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for deals.
>
> **territory\_id** `string`
>
> Territory identifier to filter deals by territory, represented as a string.
>
> **include\_child** `boolean`
>
> Include child territory records (default: false). Only applicable when territory\_id is provided.
>
> **approval\_state** `string ("approved" | "approval_process_pending" | "approval_process_rejected" | "review_process_pending" | "review_process_rejected" | "webform_unapproved" | "webform_invalid" | "webform_invalid_approval" | "webform_double_optin" | "merge_pending" | "zia_vision_pending" | "zia_vision_validation" | "zia_vision_rejected")`
>
> Filter deals by the documented Zoho CRM V3 approval or review state.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Events
>
> **Slug:** `ZOHO_LIST_EVENTS`
>
> Lists Zoho CRM Events (displayed as Meetings in the UI), with pagination and filtering. Page-based pagination is limited to the first 2,000 records; use the previous response's info.next\_page\_token for token-based pagination beyond that limit.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated event record IDs to fetch specific events. When using page\_token, this must match the original query.
>
> **cvid** `integer`
>
> Custom view ID to filter the events. Cannot be used together with sort\_by. When using page\_token, this must match the original query.
>
> **page** `integer`
>
> Page number to retrieve. Without page\_token, only the first 2,000 events are accessible. Maximum page number is floor(2000/per\_page). Cannot be used together with page\_token.
>
> **fields** `string` *required*
>
> Comma-separated API names of fields to retrieve (max 50). This parameter is required by the Zoho CRM API. Common Events fields: Event\_Title, Start\_DateTime, End\_DateTime, Location, Venue, Description, Participants, Owner, Created\_Time, Modified\_Time, \$event\_cancelled. Note: Events module is also displayed as 'Meetings' in Zoho CRM UI. Field names are case-sensitive and must match exact API names.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting Zoho CRM Events.
>
> **per\_page** `integer`
>
> Number of events per page (max 200). Default: 25. Applies to both page and page\_token pagination.
>
> **page\_token** `string`
>
> Token-based pagination to fetch events beyond the 2,000-record limit. Use next\_page\_token from the previous response. Cannot be used with page parameter.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for events.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Functions
>
> **Slug:** `ZOHO_LIST_FUNCTIONS`
>
> List configured Zoho CRM functions and their metadata.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve within the first 2,000 functions. Do not use with page\_token; page\_token takes precedence when provided.
>
> **per\_page** `integer`
>
> Maximum functions to return per page (1-200). Omitted from the request when page\_token is provided because the token preserves the original page size.
>
> **page\_token** `string`
>
> Token from info.next\_page\_token or info.previous\_page\_token for records beyond the first 2,000. When provided, it takes precedence over page and per\_page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Leads
>
> **Slug:** `ZOHO_LIST_LEADS`
>
> Retrieves lead records from Zoho CRM's Leads module with pagination support. Use this action when you need to list, filter, or paginate through leads in the CRM. Supports both discrete pagination (up to 2,000 leads) and token-based pagination for larger datasets.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated lead record IDs to fetch specific leads. When using page\_token, this must match the original query.
>
> **cvid** `integer`
>
> Custom view ID to filter the leads. Cannot be used together with sort\_by. When using page\_token, this must match the original query.
>
> **page** `integer`
>
> Page number to retrieve. Without page\_token, only the first 2,000 leads are accessible using page/per\_page. Maximum page number is floor(2000/per\_page). Do not use together with page\_token.
>
> **fields** `string`
>
> Comma-separated API names of the fields to retrieve (max 50). At least one field must be specified (empty string not allowed). Common Lead fields: First\_Name, Last\_Name, Full\_Name, Email, Phone, Mobile, Company, Lead\_Status, Lead\_Source, Industry, Annual\_Revenue, Rating, Website, Skype\_ID, Twitter, Fax, Street, City, State, Zip\_Code, Country, Description, Created\_Time, Modified\_Time. Invalid field names silently produce missing columns rather than explicit errors.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting Zoho CRM leads.
>
> **per\_page** `integer`
>
> Number of leads per page. Maximum is 200. Applies to both page and page\_token pagination.
>
> **converted** `string ("true" | "false" | "both")`
>
> Filter leads by conversion status.
>
> **page\_token** `string`
>
> Token-based pagination parameter to fetch leads beyond the 2,000-record discrete limit. Use the info.next\_page\_token from the previous response. Cannot be used together with page.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for leads.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Modules
>
> **Slug:** `ZOHO_LIST_MODULES`
>
> Lists all available Zoho CRM modules (standard + custom) to reliably select module API names/IDs for operations. Use this tool before calling other module-specific operations to ensure correct module\_api\_name selection and avoid INVALID\_MODULE errors. Particularly useful for discovering custom modules and their exact API names.
>
> #### Input Parameters
>
> **status** `array`
>
> Module statuses to include. Multiple values are sent as a comma-separated query value.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Notes
>
> **Slug:** `ZOHO_LIST_NOTES`
>
> Retrieves one paginated list of notes across all Zoho CRM modules, with fields selected by the caller; notes are returned in chronological order (oldest first by default). Zoho restricts this organization-wide GET /Notes endpoint to users with an admin profile.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve. Default is 1.
>
> **fields** `string` *required*
>
> Comma-separated API names of the fields to retrieve. This parameter is mandatory. Common fields: Note\_Title, Note\_Content, Owner, Created\_Time, Modified\_Time, Parent\_Id. Example: 'Note\_Title,Note\_Content,Created\_Time,Owner'
>
> **per\_page** `integer`
>
> Number of notes per page. Default is 25, maximum is 200.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Attachments for Zoho CRM Record
>
> **Slug:** `ZOHO_LIST_RECORD_ATTACHMENTS`
>
> Tool to list attachment metadata (id, File\_Name, Size, Created\_Time, etc.) for a specific Zoho CRM record. Use when you need to identify attachments before downloading them via other means. This returns metadata only, not the actual file content.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1).
>
> **fields** `string`
>
> Comma-separated API names of attachment fields to retrieve. Common fields: id, File\_Name, Size, Created\_Time, Modified\_Time, Owner, Parent\_Id, Created\_By, Modified\_By, \$editable, \$file\_id, \$se\_module.
>
> **per\_page** `integer`
>
> Number of attachments per page (default and maximum: 200).
>
> **record\_id** `string` *required*
>
> The unique ID of the record to list attachments for.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module containing the record. Examples: 'Leads', 'Contacts', 'Accounts', 'Deals', etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Tags
>
> **Slug:** `ZOHO_LIST_TAGS`
>
> List the tags available for a Zoho CRM module.
>
> #### Input Parameters
>
> **my\_tags** `boolean`
>
> Whether to return only tags created by the current user. When omitted, Zoho uses its default of false.
>
> **module\_api\_name** `string` *required*
>
> Case-sensitive API name of the Zoho CRM module whose tags should be returned, such as Leads, Contacts, Deals, or a custom module API name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Tasks
>
> **Slug:** `ZOHO_LIST_TASKS`
>
> Retrieves tasks from the Tasks module in Zoho CRM with support for filtering, pagination, and sorting. Use this action when you need to fetch a page of tasks or specific tasks by IDs. Supports both discrete pagination (up to 2,000 tasks) and token-based pagination for larger datasets. Notes: - Discrete (page/per\_page) pagination is limited to the first 2,000 tasks. To retrieve tasks beyond this, use token-based pagination via page\_token from the previous response's info.next\_page\_token. - Do not use page together with page\_token. - You cannot use cvid together with sort\_by.
>
> #### Input Parameters
>
> **ids** `string`
>
> Comma-separated task IDs to fetch specific tasks. When using page\_token, this must match the original query.
>
> **cvid** `integer`
>
> Custom view ID to filter the tasks. Cannot be used together with sort\_by. When using page\_token, this must match the original query.
>
> **page** `integer`
>
> Page number to retrieve. Without page\_token, only the first 2,000 tasks are accessible using page/per\_page. Maximum page number is floor(2000/per\_page). Do not use together with page\_token.
>
> **fields** `string`
>
> Comma-separated API names of the fields to retrieve (max 50). At least one field must be specified (empty string not allowed). Common fields: Subject, Status, Priority, Due\_Date, Owner, Description, Created\_Time, Modified\_Time, Reminder, Closed\_Time, What\_Id (related record). Invalid field names silently produce missing columns rather than explicit errors.
>
> **sort\_by** `string ("id" | "Created_Time" | "Modified_Time")`
>
> Valid fields for sorting Zoho CRM tasks.
>
> **per\_page** `integer`
>
> Number of tasks per page (default 25, max 200). Applies to both page and page\_token pagination.
>
> **page\_token** `string`
>
> Token-based pagination parameter to fetch tasks beyond the 2,000-record discrete limit. Use the info.next\_page\_token from the previous response. Cannot be used together with page.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort order for tasks.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Variables
>
> **Slug:** `ZOHO_LIST_VARIABLES`
>
> List Zoho CRM configuration variables and their current values.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Zoho CRM Workflow Rules
>
> **Slug:** `ZOHO_LIST_WORKFLOW_RULES`
>
> List and filter workflow rules configured in Zoho CRM.
>
> #### Input Parameters
>
> **page** `integer`
>
> One-based page number to return.
>
> **module** `string`
>
> API name of the primary CRM module whose workflow rules to return.
>
> **per\_page** `integer`
>
> Number of workflow rules to return per page, from 1 through 200.
>
> **execute\_on** `string ("create" | "edit" | "create_or_edit" | "delete" | "field_update" | "rollup_summary_update" | "section_update" | "date_or_datetime" | "score_increase" | "score_update" | "score_decrease" | "recommendation" | "scheduled_call_field_update" | "scheduled_call_section_update" | "scheduled_call_edit" | "scheduled_call_createedit" | "outgoing_call_ring" | "outgoing_call_start" | "outgoing_call_section_update" | "outgoing_call_createedit" | "outgoing_call_field_update" | "outgoing_call_edit" | "incoming_call_ring" | "incoming_call_start" | "incoming_call_edit" | "incoming_call_field_update" | "incoming_call_createedit" | "incoming_call_section_update" | "anyaction" | "missed_call" | "reschedule" | "cancel" | "reassign" | "overdue" | "marked_as_complete" | "email_received" | "mail_sent" | "mail_sent_clicked" | "mail_sent_replied" | "mail_sent_opened" | "mail_sent_bounced" | "email_received_notreplied" | "email_received_opened_notreplied" | "mail_sent_replied_within" | "mail_sent_opened_notreplied" | "mail_sent_notreplied" | "mail_sent_notopened" | "fb_post_on_page" | "fb_comment_on_page" | "fb_like_on_post" | "fb_send_message" | "tw_mention_on" | "tw_retweet_on_tweet" | "tw_comment_on_tweet" | "tw_send_message")`
>
> Record action or trigger type on which the workflow rule executes. Requires module.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort rules by modified\_time in ascending or descending order.
>
> **name\_contains** `string`
>
> Return workflow rules whose name contains this value.
>
> **status\_active** `boolean`
>
> Whether to return only active rules (true) or only inactive rules (false).
>
> **trigger\_module** `string`
>
> API name of the related module that triggers the workflow rule. Requires module.
>
> **include\_inner\_details** `boolean`
>
> Whether to include conditions, criteria details, instant actions, and scheduled actions. Requires module.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Merge Zoho CRM Leads
>
> **Slug:** `ZOHO_MERGE_LEADS`
>
> Merge duplicate leads into a retained master lead and delete the child leads.
>
> #### Input Parameters
>
> **child\_records** `array` *required*
>
> One or two duplicate leads to merge into the master lead.
>
> **master\_record\_id** `string` *required*
>
> Unique ID of the master lead that will be retained.
>
> **master\_record\_fields** `array`
>
> Optional fields whose values should be retained from the master lead.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zoho CRM Accounts
>
> **Slug:** `ZOHO_SEARCH_ACCOUNTS`
>
> Search for Account records within Zoho CRM using server-side queries. Returns a paginated page of accounts matching the specified criteria, phone, or keyword, up to the API's 2,000-record search limit.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple fields in the Accounts module. Cannot be used together with criteria or phone parameters.
>
> **phone** `string`
>
> Search for this phone number across all phone fields in the Accounts module. Cannot be used together with criteria or word parameters.
>
> **fields** `string`
>
> Comma-separated API names of fields to return in the response. If not specified, all fields are returned. Common Account fields: Account\_Name, Website, Phone, Industry, Annual\_Revenue, Number\_of\_Employees, Billing\_Street, Billing\_City, Billing\_State, Billing\_Country.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter by approval status: true, false, or both.
>
> **criteria** `string`
>
> Search using field conditions in format (Field\_API\_Name:operator:value). Multiple conditions: ((Field1:op:val)and/or(Field2:op:val)). Operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. CRITICAL: 'contains' NOT supported—use 'equals' for substring matching or 'starts\_with' for prefix. Datetime fields require timezone: yyyy-MM-ddTHH:mm:ss+HH:mm. Max 10 criteria.
>
> **per\_page** `integer`
>
> Number of records per page. Maximum is 200.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zoho CRM Calls
>
> **Slug:** `ZOHO_SEARCH_CALLS`
>
> Search for Call records in Zoho CRM using server-side queries. Returns calls matching the specified criteria or keyword. Use this action to retrieve a paginated page of matching Call records, up to the API's 2,000-record search limit.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple fields in Call records. Cannot be used together with criteria.
>
> **fields** `string`
>
> Comma-separated API names of fields to return in the response. If not specified, all fields are returned. Common Call fields: Subject, Call\_Type, Call\_Duration, Call\_Start\_Time, Call\_Purpose, Call\_Result, Call\_Agenda, Description, Who\_Id, What\_Id, Owner. Example: 'Subject,Call\_Type,Call\_Duration,Call\_Start\_Time,Owner'.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter by approval status: true, false, or both.
>
> **criteria** `string`
>
> Advanced search using field conditions for Call records. Single condition format: (Field\_API\_Name:operator:value). Multiple conditions format: ((Field1:operator:value)and/or(Field2:operator:value)). Supported operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. CRITICAL: 'contains' operator is NOT supported by Zoho API and will cause INVALID\_QUERY errors. For substring matching on text fields, use 'equals' (performs substring search). Common Call fields: Subject, Call\_Type, Call\_Duration, Call\_Start\_Time, Call\_Purpose, Call\_Result, Call\_Agenda. Max 10 criteria. Example: ((Subject:equals:Follow Up)and(Call\_Type:equals:Outbound)). For datetime fields (e.g., Call\_Start\_Time, Created\_Time), values MUST include timezone offset in format yyyy-MM-ddTHH:mm:ss+HH:mm. Example: (Call\_Start\_Time:greater\_than:2024-01-01T00:00:00+00:00).
>
> **per\_page** `integer`
>
> Number of records per page. Maximum is 200.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zoho CRM Contacts
>
> **Slug:** `ZOHO_SEARCH_CONTACTS`
>
> Search for contacts in Zoho CRM using server-side queries by criteria, email, phone, or keyword. Use this action to find specific contacts instead of listing all contacts.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple fields in Contacts module. Searches across name, email, phone, and other text fields. Cannot be used together with criteria, email, or phone parameters.
>
> **email** `string`
>
> Search for this email address across all email fields in Contacts. Cannot be used together with criteria, phone, or word parameters.
>
> **phone** `string`
>
> Search for this phone number across all phone fields in Contacts. Cannot be used together with criteria, email, or word parameters.
>
> **fields** `string`
>
> Comma-separated API names of fields to return in the response. If not specified, all fields are returned. Common Contact fields: First\_Name, Last\_Name, Email, Phone, Mobile, Account\_Name, Mailing\_Street, Mailing\_City, Title, Department. Example: 'First\_Name,Last\_Name,Email,Phone,Account\_Name'.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter by approval status: true, false, or both.
>
> **criteria** `string`
>
> Search using field conditions. Format: (Field:operator:value) or ((Field1:op:val)and/or(Field2:op:val)). Operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. CRITICAL: 'contains' NOT supported. Use 'equals' for substring match or 'starts\_with' for prefix. Max 10 criteria. Contact fields: First\_Name, Last\_Name, Email, Phone, Mobile, Account\_Name, Mailing\_Street, etc. Datetime fields MUST include timezone: yyyy-MM-ddTHH:mm:ss+HH:mm.
>
> **per\_page** `integer`
>
> Number of records per page. Default is 25, maximum is 200.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Deals in Zoho CRM
>
> **Slug:** `ZOHO_SEARCH_DEALS`
>
> Search for Deal records in Zoho CRM using server-side queries. Returns a paginated page of matching deals, up to the API's 2,000-record search limit.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple fields in Deals module. Cannot be used together with criteria.
>
> **fields** `string`
>
> Comma-separated API names of Deal fields to return in the response. If not specified, all fields are returned. Common Deal fields: Deal\_Name, Amount, Stage, Closing\_Date, Account\_Name, Contact\_Name, Owner, Lead\_Source, Pipeline, Probability, Description. Example: 'Deal\_Name,Amount,Stage,Closing\_Date,Account\_Name'.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter by approval status: true, false, or both.
>
> **criteria** `string`
>
> Advanced search using field conditions. Format: (Field:operator:value) or ((Field1:op:val)and/or(Field2:op:val)). Operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. NOTE: 'contains' NOT supported - use 'equals' for substring or 'starts\_with' for prefix matching. Common fields: Deal\_Name, Amount, Stage, Closing\_Date, Account\_Name. Datetime fields require timezone: yyyy-MM-ddTHH:mm:ss+HH:mm. Max 10 criteria.
>
> **per\_page** `integer`
>
> Number of records per page. Maximum is 200.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Events
>
> **Slug:** `ZOHO_SEARCH_EVENTS`
>
> Search for Events in Zoho CRM using server-side queries. Returns a paginated page of events matching field criteria or keyword, up to the API's 2,000-record search limit.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple fields in Events module. Cannot be used together with criteria.
>
> **fields** `string`
>
> Comma-separated API names of fields to return in the response. If not specified, all fields are returned. Common Events fields: Event\_Title, Start\_DateTime, End\_DateTime, Location, Description, Venue, Participants, \$event\_cancelled. Example: 'Event\_Title,Start\_DateTime,End\_DateTime,Location'.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter by approval status: true, false, or both.
>
> **criteria** `string`
>
> Advanced search using field conditions. Single condition format: (Field\_API\_Name:operator:value). Multiple conditions format: ((Field1:operator:value)and/or(Field2:operator:value)). Supported operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. CRITICAL: 'contains' operator is NOT supported by Zoho API and will cause INVALID\_QUERY errors. For substring matching on text fields, use 'equals' (performs substring search). For prefix matching, use 'starts\_with'. Max 10 criteria. Example: ((Event\_Title:equals:Meeting)and(Start\_DateTime:greater\_than:2026-01-01T00:00:00+00:00)). Common Events fields: Event\_Title, Start\_DateTime, End\_DateTime, Location, Description, Venue, Participants. For datetime fields, values MUST include timezone offset in format yyyy-MM-ddTHH:mm:ss+HH:mm.
>
> **per\_page** `integer`
>
> Number of records per page. Maximum is 200.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Leads
>
> **Slug:** `ZOHO_SEARCH_LEADS`
>
> Search for lead records in Zoho CRM using server-side queries. Returns a paginated page of matching leads, up to the API's 2,000-record search limit.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple fields in the Leads module. Cannot be used together with criteria, email, or phone parameters. Exactly one of criteria, email, phone, or word must be provided.
>
> **email** `string`
>
> Search for this email address across all email fields in the Leads module. Cannot be used together with criteria, phone, or word parameters. Exactly one of criteria, email, phone, or word must be provided.
>
> **phone** `string`
>
> Search for this phone number across all phone fields in the Leads module. Cannot be used together with criteria, email, or word parameters. Exactly one of criteria, email, phone, or word must be provided.
>
> **fields** `string`
>
> Comma-separated API names of fields to return in the response. If not specified, all fields are returned. Common Lead fields: First\_Name, Last\_Name, Email, Phone, Mobile, Company, Lead\_Status, Lead\_Source, Industry, Annual\_Revenue, Rating, Website, Created\_Time, Modified\_Time.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter for approved record status.
>
> **criteria** `string`
>
> Field conditions in format (Field:operator:value) or ((Field1:op:val)and/or(Field2:op:val)). Operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. CRITICAL: 'contains' not supported - use 'equals' for substring match or 'starts\_with' for prefix. Max 10 criteria. Common fields: First\_Name, Last\_Name, Email, Phone, Company, Lead\_Status, Lead\_Source. Datetime fields require timezone offset: yyyy-MM-ddTHH:mm:ss+HH:mm. Exactly one of criteria/email/phone/word required.
>
> **per\_page** `integer`
>
> Number of records per page. Maximum is 200.
>
> **converted** `string ("true" | "false" | "both")`
>
> Filter for converted lead status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Notes
>
> **Slug:** `ZOHO_SEARCH_NOTES`
>
> Search for notes in Zoho CRM using server-side queries. Returns a paginated page of matching notes, up to the API's 2,000-record search limit.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple note fields including Note\_Title and Note\_Content. Cannot be used together with criteria.
>
> **fields** `string`
>
> Comma-separated API names of fields to return in the response. If not specified, all fields are returned. Common note fields: Note\_Title, Note\_Content, Created\_Time, Modified\_Time, Owner, Parent\_Id, \$attachments. Example: 'Note\_Title,Note\_Content,Created\_Time'.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter by approval status: true, false, or both.
>
> **criteria** `string`
>
> Advanced search using field conditions. Single condition format: (Field\_API\_Name:operator:value). Multiple conditions format: ((Field1:operator:value)and/or(Field2:operator:value)). Supported operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. CRITICAL: 'contains' operator is NOT supported by Zoho API and will cause INVALID\_QUERY errors. For substring matching on text fields, use 'equals' (performs substring search, e.g., 'equals:meeting' matches 'Meeting notes'). For prefix matching, use 'starts\_with'. Common Note fields: Note\_Title, Note\_Content, Created\_Time, Modified\_Time, Parent\_Id. Max 10 criteria. Example: ((Note\_Title:equals:Meeting)and(Created\_Time:greater\_than:2026-01-01T00:00:00+00:00)). For datetime fields (e.g., Created\_Time, Modified\_Time), values MUST include timezone offset in format yyyy-MM-ddTHH:mm:ss+HH:mm.
>
> **per\_page** `integer`
>
> Number of records per page. Maximum is 200.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zoho CRM Tasks
>
> **Slug:** `ZOHO_SEARCH_TASKS`
>
> Search for tasks in Zoho CRM using flexible criteria. Returns a paginated page of matching tasks, up to the API's 2,000-record search limit.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple fields in the Tasks module. Cannot be used together with criteria.
>
> **fields** `string`
>
> Comma-separated API names of fields to return in the response. If not specified, all fields are returned. Common Task fields: Subject, Status, Priority, Due\_Date, Closed\_Time, Created\_Time, Modified\_Time, Owner, What\_Id, Who\_Id, Description. Example: 'Subject,Status,Priority,Due\_Date'.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter by approval status: true, false, or both.
>
> **criteria** `string`
>
> Search criteria using format: (Field\_API\_Name:operator:value). Multiple conditions: ((Field1:op:val)and/or(Field2:op:val)). Operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. CRITICAL: 'contains' NOT supported - use 'equals' for substring match or 'starts\_with' for prefix. Max 10 criteria. Valid fields: Subject, Status, Priority, Due\_Date, Closed\_Time, Created\_Time, Modified\_Time. Datetime fields MUST include timezone: yyyy-MM-ddTHH:mm:ss+HH:mm (e.g., 2024-01-01T00:00:00+00:00). For full-text search, use 'word' parameter instead.
>
> **per\_page** `integer`
>
> Number of records per page. Default is 25, maximum is 200.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Zoho CRM Records
>
> **Slug:** `ZOHO_SEARCH_ZOHO_RECORDS`
>
> Search for records within a Zoho CRM module using server-side queries. Use when you need to find specific records by criteria, email, phone, or keyword. Results are paginated at up to 200 records per page and limited to 2,000 records per search.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per\_page).
>
> **word** `string`
>
> Global search keyword across multiple fields in the module. Cannot be used together with criteria, email, or phone parameters.
>
> **email** `string`
>
> Search for this email address across all email fields in the module. Cannot be used together with criteria, phone, or word parameters.
>
> **phone** `string`
>
> Search for this phone number across all phone fields in the module. Cannot be used together with criteria, email, or word parameters.
>
> **fields** `string`
>
> Comma-separated API names of fields to return in the response. If not specified, all fields are returned. Example: 'First\_Name,Last\_Name,Email,Phone'.
>
> **approved** `string ("true" | "false" | "both")`
>
> Filter by approval status: true, false, or both.
>
> **criteria** `string`
>
> Advanced search using field conditions. Single condition format: (Field\_API\_Name:operator:value). Multiple conditions format: ((Field1:operator:value)and/or(Field2:operator:value)). Supported operators: equals, starts\_with, in, not\_equal, greater\_equal, greater\_than, less\_equal, less\_than, between. CRITICAL: 'contains' operator is NOT supported by Zoho API and will cause INVALID\_QUERY errors. For substring matching on text fields, use 'equals' (performs substring search, e.g., 'equals:Smith' matches 'John Smith'). For prefix matching, use 'starts\_with'. For exact matching on picklists, use 'equals'. For full-text search across multiple fields, use the 'word' parameter instead of criteria. Max 10 criteria. Example: ((Last\_Name:equals:Smith)and(Email:starts\_with:john)). Field names must be valid API names for the module. For datetime fields (e.g., Created\_Time, Modified\_Time), values MUST include timezone offset in format yyyy-MM-ddTHH:mm:ss+HH:mm. Example: (Created\_Time:greater\_than:2026-01-01T00:00:00+00:00).
>
> **per\_page** `integer`
>
> Number of records per page. Default and maximum is 200.
>
> **converted** `string ("true" | "false" | "both")`
>
> Filter conversion status for modules that support conversion, such as Leads.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module to search in. Standard modules use PascalCase (e.g., 'Leads', 'Contacts', 'Accounts', 'Deals'). Custom modules must use their exact API name as configured in Zoho CRM.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Account
>
> **Slug:** `ZOHO_UPDATE_ACCOUNT`
>
> Updates an existing Account record in Zoho CRM with the specified field values. Only the fields provided in the request will be updated; other fields remain unchanged. Use this action when you need to modify specific details of an existing account, such as contact information, address, ownership, or business details. All field updates use API field names (not display labels), and lookup fields require properly formatted dictionaries with 'id' keys.
>
> #### Input Parameters
>
> **Fax** `string`
>
> Fax number for the account
>
> **Owner** `object`
>
> Owner lookup field, formatted as \{'id': 'zoho\_user\_id'}. Use the Zoho user ID, not email or display name
>
> **Phone** `string`
>
> Primary phone number for the account
>
> **Rating** `string`
>
> Rating of the account (e.g., 'Active', 'Market Failed', 'Project Cancelled', 'Shutdown')
>
> **Website** `string`
>
> Company website URL
>
> **trigger** `array`
>
> Automation triggers to execute during update.
>
> **Industry** `string`
>
> Industry sector of the account (e.g., 'ASP', 'Data/Telecom OEM', 'ERP', 'Government/Military', 'Large Enterprise', 'ManagementISV', 'MSP', 'Network Equipment', 'Non-profit', 'Small Business', 'Storage', 'Other')
>
> **SIC\_Code** `string`
>
> Standard Industrial Classification Code
>
> **Employees** `integer`
>
> Number of employees at the company
>
> **Ownership** `string`
>
> Ownership type (e.g., 'Public', 'Private', 'Subsidiary', 'Other')
>
> **record\_id** `string` *required*
>
> Unique identifier of the Account record to update
>
> **Description** `string`
>
> Additional notes or description about the account
>
> **Account\_Name** `string`
>
> Name of the account/company
>
> **Account\_Site** `string`
>
> Account site or location identifier
>
> **Account\_Type** `string`
>
> Type/category of the account (e.g., 'Analyst', 'Competitor', 'Customer', 'Integrator', 'Investor', 'Partner', 'Press', 'Prospect', 'Reseller', 'Other')
>
> **Billing\_City** `string`
>
> City for billing address
>
> **Billing\_Code** `string`
>
> Postal/ZIP code for billing address
>
> **Billing\_State** `string`
>
> State/province for billing address
>
> **Shipping\_City** `string`
>
> City for shipping address
>
> **Shipping\_Code** `string`
>
> Postal/ZIP code for shipping address
>
> **Ticker\_Symbol** `string`
>
> Stock ticker symbol (if publicly traded)
>
> **Account\_Number** `integer`
>
> Account number or identifier (numeric value)
>
> **Annual\_Revenue** `number`
>
> Annual revenue of the company
>
> **Billing\_Street** `string`
>
> Street address for billing
>
> **Parent\_Account** `object`
>
> Parent account lookup field, formatted as \{'id': 'parent\_account\_id'}
>
> **Shipping\_State** `string`
>
> State/province for shipping address
>
> **Billing\_Country** `string`
>
> Country for billing address
>
> **Shipping\_Street** `string`
>
> Street address for shipping
>
> **Shipping\_Country** `string`
>
> Country for shipping address
>
> **skip\_feature\_execution** `array`
>
> Features to skip during update, such as cadences.
>
> **apply\_feature\_execution** `array`
>
> Features to execute during update, such as layout\_rules or criteria\_validation\_rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Call
>
> **Slug:** `ZOHO_UPDATE_CALL`
>
> Updates existing call records in the Calls module in Zoho CRM. Supports updating up to 100 call records per API call. Use this action when you need to modify call details such as call duration, call type, subject, or related contacts/leads. Use field API names (not display names) for all field updates. The 'id' field is mandatory for each call record. Note: For Inbound or Outbound calls, the Call\_Duration must be non-zero or the API will return a DEPENDENT\_MISMATCH error.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> A list of dictionaries representing the call records to be updated. Each record MUST include the 'id' field with the call record ID to update. Update up to 100 records per API call. Use field API names as keys (not display names). Common call fields: Subject, Call\_Type (Inbound/Outbound/Missed), Call\_Start\_Time, Call\_Duration, Call\_Purpose, Call\_Agenda, Description, Who\_Id (Contact), What\_Id (Lead/Account/Deal), Owner. IMPORTANT: For Inbound or Outbound calls, Call\_Duration MUST be non-zero. Zero duration triggers DEPENDENT\_MISMATCH error. For lookup fields (What\_Id, Who\_Id), use format: \{'id': 'record\_id', 'module': \{'api\_name': 'ModuleName'}}. For owner assignment, use \{'id': '\<zoho\_user\_id>'}; using email or display name will fail. Example: \[\{'id': '123456789', 'Subject': 'Follow-up call', 'Call\_Duration': 600, 'Call\_Type': 'Outbound'}]
>
> **trigger** `array`
>
> List of automation triggers to execute during update. Valid values: \['workflow', 'approval', 'blueprint', 'pathfinder', 'orchestration']. Pass empty array \[] to skip all automation. If not specified, default triggers execute. Example: \['workflow', 'blueprint']
>
> **skip\_feature\_execution** `array`
>
> Features to skip during the update. Example: \[\{'name': 'cadences'}] to skip cadence execution
>
> **apply\_feature\_execution** `array`
>
> Features to execute during the update. Example: \[\{'name': 'layout\_rules'}] or \[\{'name': 'criteria\_validation\_rule'}]
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Custom Fields
>
> **Slug:** `ZOHO_UPDATE_CUSTOM_FIELDS`
>
> Update custom-field definitions; some changes can alter existing record values.
>
> #### Input Parameters
>
> **fields** `array` *required*
>
> One to five custom-field updates using Zoho's exact property names. Each object is forwarded unchanged. On the collection route, every object must include the field's id; with field\_id, pass exactly one object without an id. Common updates include field\_label, length, unique, pick\_list\_values, history\_tracking\_enabled, and history\_tracking. Global-picklist conversions can replace existing record and configuration values; include only properties you intend to change.
>
> **field\_id** `string`
>
> The unique ID of one custom field. When provided, fields must contain exactly one update object. Omit it to update one or more custom fields.
>
> **module\_api\_name** `string` *required*
>
> The API name of the Zoho CRM module containing the custom fields, such as Leads, Contacts, or a custom module API name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Custom View
>
> **Slug:** `ZOHO_UPDATE_CUSTOM_VIEW`
>
> Update the configuration of one Zoho CRM custom view.
>
> #### Input Parameters
>
> **name** `string`
>
> New name for the custom view.
>
> **fields** `array`
>
> Up to 250 displayed fields with optional pin, pixel width, and pin-order configuration.
>
> **locked** `boolean`
>
> Whether the custom view is locked.
>
> **sort\_by** `object`
>
> Field reference used to sort the view, such as an object containing api\_name and id. Pass null to remove sorting.
>
> **category** `string ("public_views" | "other_users_views" | "shared_with_me" | "created_by_me")`
>
> Documented category used to organize the custom view.
>
> **criteria** `string`
>
> A typed field criterion or nested group. Pass null to remove all criteria and return all records.
>
> **favorite** `integer`
>
> Favorite order, or null to remove the view from favorites.
>
> **shared\_to** `array`
>
> Optional users, roles, groups, or territories that can access the view. Pass null to clear an existing sharing list.
>
> **sort\_order** `string ("asc" | "desc")`
>
> Sort direction. Pass null when removing sorting.
>
> **access\_type** `string ("shared" | "public" | "only_to_me")`
>
> Who can access the custom view.
>
> **cross\_filters** `array`
>
> Up to three filters over related-module records. Pass null to remove all cross filters.
>
> **custom\_view\_id** `string` *required*
>
> Unique ID of the custom view to update.
>
> **module\_api\_name** `string` *required*
>
> API name of the Zoho CRM module that owns the custom view.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Deal
>
> **Slug:** `ZOHO_UPDATE_DEAL`
>
> Updates an existing deal in Zoho CRM. Use this action when you need to modify specific fields of a deal record, such as updating the deal amount, stage, closing date, or associated account. Only the fields included in the data parameter will be modified; other fields remain unchanged. Use when you have a specific deal ID and want to update one or more fields without affecting others.
>
> #### Input Parameters
>
> **data** `object` *required*
>
> Object containing the deal fields to update. Use field API names as keys (not display names). Common fields include: 'Deal\_Name', 'Amount', 'Stage', 'Closing\_Date', 'Account\_Name' (as lookup: \{'id': 'account\_id'}), 'Contact\_Name' (as lookup: \{'id': 'contact\_id'}), 'Owner' (as lookup: \{'id': 'user\_id'}). Only include fields you intend to modify — unintended fields will overwrite existing data. For lookup fields, use format: \{'id': 'record\_id'} or \{'id': 'record\_id', 'name': 'Display Name'}. Read-only or layout-restricted fields cause INVALID\_DATA errors. This model accepts any additional Zoho CRM deal fields via the extra='allow' configuration.
>
> **deal\_id** `string` *required*
>
> The unique identifier of the deal to update. This is the Zoho CRM record ID.
>
> **trigger** `array`
>
> List of automation triggers to execute during update. Valid values: \['workflow', 'approval', 'blueprint', 'pathfinder', 'orchestration']. Pass empty array \[] to skip all automation. If not specified, default triggers execute. Example: \['workflow', 'blueprint']
>
> **skip\_feature\_execution** `array`
>
> Features to skip during the update. Example: \[\{'name': 'cadences'}] to skip cadence execution
>
> **apply\_feature\_execution** `array`
>
> Features to execute during the update. Example: \[\{'name': 'layout\_rules'}] or \[\{'name': 'criteria\_validation\_rule'}]
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Email Draft
>
> **Slug:** `ZOHO_UPDATE_EMAIL_DRAFT`
>
> Updates an existing email draft associated with a record in Zoho CRM. Requires the draft ID, sender address, and text format. Use this action when you need to modify the recipients, subject, content, scheduling, or attachments of an existing email draft before sending. Supports updating up to 100 email drafts per API call. Schedule times must be in the future.
>
> #### Input Parameters
>
> **record\_id** `string` *required*
>
> Unique identifier of the record to which the email draft is associated
>
> **email\_drafts** `array` *required*
>
> Email draft objects to update, from 1 to 100 per request
>
> **module\_api\_name** `string` *required*
>
> The API name of the module containing the record to which the email draft is associated. Valid modules: Leads, Contacts, Deals, Accounts, Sales\_Orders, Purchase\_Orders, Invoices, Quotes, Cases, or Custom modules. Must use exact API name (PascalCase for standard modules).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Event
>
> **Slug:** `ZOHO_UPDATE_EVENT`
>
> Updates existing events in Zoho CRM. Supports updating up to 100 events per API call. Use this action when you need to modify event details such as title, start/end times, location, participants, or related records (What\_Id/Who\_Id). The 'id' field is mandatory for each event, and only specified fields will be updated.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> A list of dictionaries representing the events to be updated. Each event MUST include the 'id' field with the event ID to update. Update up to 100 events per API call. Common event fields: Event\_Title (string, title/subject of the event), Start\_DateTime (ISO 8601 datetime, event start date and time), End\_DateTime (ISO 8601 datetime, event end date and time), Description (string, event description), Location (string, event location), Participants (array of participant objects, max 50 participants), Remind\_At (ISO 8601 datetime, reminder time), All\_day (boolean, whether event is all-day), Check\_In\_Status (string, check-in status), What\_Id (dict with 'id' and optional 'module' for a related business object, including Leads), Who\_Id (dict with 'id' for a related Contact). Only include fields you intend to modify — unintended fields will overwrite existing data. Read-only or layout-restricted fields cause INVALID\_DATA errors.
>
> **trigger** `array`
>
> List of automation triggers to execute during update. Valid values: \['workflow', 'approval', 'blueprint', 'pathfinder', 'orchestration']. Pass empty array \[] to skip all automation. If not specified, default triggers execute. Example: \['workflow', 'blueprint']
>
> **skip\_feature\_execution** `array`
>
> Features to skip during update, such as cadences.
>
> **apply\_feature\_execution** `array`
>
> Features to execute during update, such as layout\_rules or criteria\_validation\_rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Layout
>
> **Slug:** `ZOHO_UPDATE_LAYOUT`
>
> Update a custom layout's metadata, profile access, sections, or fields.
>
> #### Input Parameters
>
> **layout** `object` *required*
>
> Layout changes. This action supports renaming, business-card visibility, profile access changes, and section or field configuration changes.
>
> **layout\_id** `string` *required*
>
> Unique numeric ID of the custom layout to update.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the CRM module that owns the layout.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Lead
>
> **Slug:** `ZOHO_UPDATE_LEAD`
>
> Updates existing lead records in Zoho CRM. Supports updating up to 100 leads per API call. Use this action when you need to modify lead information such as contact details, lead status, lead source, or other lead-specific fields. Use field API names (not display names) for all field updates. The 'id' field is mandatory for each lead.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> A list of lead records to be updated. Each lead MUST include the 'id' field with the lead record ID to update. Update up to 100 leads per API call. Use field API names as keys (not display names). Common updatable fields: Last\_Name, First\_Name, Email, Phone, Mobile, Company, Lead\_Source, Lead\_Status, Industry, Rating, Street, City, State, Country, Zip\_Code. For owner assignment, use the 'Owner' field with value \{'id': '\<zoho\_user\_id>'}; using email or display name will fail. Only include fields you intend to modify — unintended fields will overwrite existing data. Read-only or layout-restricted fields cause INVALID\_DATA errors. The model supports custom fields via 'extra=allow' configuration.
>
> **trigger** `array`
>
> List of automation triggers to execute during update. Valid values: \['workflow', 'approval', 'blueprint', 'pathfinder', 'orchestration']. Pass empty array \[] to skip all automation. If not specified, default triggers execute. Example: \['workflow', 'blueprint']
>
> **skip\_feature\_execution** `array`
>
> Features to skip during the update. Example: \[\{'name': 'cadences'}] to skip cadence execution
>
> **apply\_feature\_execution** `array`
>
> Features to execute during the update. Example: \[\{'name': 'layout\_rules'}] or \[\{'name': 'criteria\_validation\_rule'}]
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Note
>
> **Slug:** `ZOHO_UPDATE_NOTE`
>
> Updates an existing Zoho CRM note by ID, including its title, content, or portal-user sharing setting.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> The unique identifier of the note to update
>
> **Note\_Title** `string`
>
> Updated title of the note. If not provided, the existing title remains unchanged.
>
> **Note\_Content** `string`
>
> Updated content/body of the note. If not provided, the existing content remains unchanged.
>
> **is\_shared\_to\_client** `boolean`
>
> Controls portal user visibility. Set to true to share note with portal users, false to keep private. If not provided, the existing setting remains unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Related Records in Zoho CRM
>
> **Slug:** `ZOHO_UPDATE_RELATED_RECORDS`
>
> Associates or updates relationships between records across different modules in Zoho CRM. This action creates or modifies relationships between a parent record and related records. Common use cases: - Associate Leads/Contacts with Campaigns (with member status) - Link Products to Deals/Quotes/Accounts - Connect Contacts to Accounts - Associate Services with Appointments Use ZOHO\_GET\_RELATED\_LISTS to discover valid related\_list\_api\_name values for your module. Maximum 100 related records can be updated per API call. If module\_api\_name, record\_id, related\_list\_api\_name, or child record IDs in data do not match Zoho CRM's related-list configuration exactly, associations may silently succeed (no error returned) but the relationship will not be created.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> A list of related records to associate with the parent record. Each dictionary must include: 1) 'id' (string, mandatory): The unique ID of the related record to associate. 2) Optional fields to update (e.g., 'Member\_Status' for campaign members). Maximum 100 related records per API call. Example: \[\{'id': '5725767000000327001', 'Member\_Status': 'Active'}]
>
> **record\_id** `string` *required*
>
> The unique identifier (ID) of the parent record to which related records will be associated. This is the numeric ID from Zoho CRM (e.g., '5725767000000649013').
>
> **module\_api\_name** `string` *required*
>
> The API name of the parent module where the record resides. Common modules: 'Leads', 'Contacts', 'Accounts', 'Deals', 'Products', 'Quotes'. Use the exact module API name (PascalCase, e.g., 'Contacts' not 'contacts').
>
> **related\_list\_api\_name** `string` *required*
>
> The API name of the related list/module to update relationships with. Common examples: 'Campaigns' (for Lead-Campaign relations), 'Products' (for Deal-Product relations), 'Contacts' (for Account-Contact relations). Use ZOHO\_GET\_RELATED\_LISTS action to discover valid related list API names for a specific module.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM User
>
> **Slug:** `ZOHO_UPDATE_USER`
>
> Update a Zoho CRM user's name, email, contact details, locale, time preferences, role, profile, or status by ID.
>
> #### Input Parameters
>
> **changes** `object` *required*
>
> Supported user settings to update.
>
> **user\_id** `string` *required*
>
> ID of the CRM user to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Webform
>
> **Slug:** `ZOHO_UPDATE_WEBFORM`
>
> Replace one Zoho CRM webform configuration using the V8 path-ID route.
>
> #### Input Parameters
>
> **webform** `object` *required*
>
> Complete replacement configuration for the webform.
>
> **webform\_id** `string` *required*
>
> Unique ID of the webform selected by the request path.
>
> **module\_api\_name** `string` *required*
>
> Module API name sent in the mandatory module query parameter.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Workflow Rule
>
> **Slug:** `ZOHO_UPDATE_WORKFLOW_RULE`
>
> Update a Zoho CRM workflow rule's name, description, or activation status by ID.
>
> #### Input Parameters
>
> **rule\_id** `string` *required*
>
> Unique ID of the workflow rule to update.
>
> **workflow\_rule** `object` *required*
>
> Changes to the workflow rule's name, description, or activation status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Zoho CRM Record
>
> **Slug:** `ZOHO_UPDATE_ZOHO_RECORD`
>
> Updates up to 100 existing records in a specified Zoho CRM module using field API names and an ID for each record. A batch can partially succeed even when the tool reports an error.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> A list of dictionaries representing the records to be updated. Each record MUST include the 'id' field with the record ID to update. Update up to 100 records per API call. Use field API names as keys (not display names). For multi-module lookup fields (What\_Id, Who\_Id), use format: \{'field\_name': \{'id': 'record\_id', 'module': \{'api\_name': 'ModuleName'}}}. Example: \[\{'id': '123456789', 'Last\_Name': 'Smith', 'What\_Id': \{'id': '987654321', 'module': \{'api\_name': 'Accounts'}}}] For owner assignment, use the owner field API name (e.g., 'Owner') with value \{'id': '\<zoho\_user\_id>'}; using email or display name will fail. Only include fields you intend to modify — unintended fields will overwrite existing data. Read-only or layout-restricted fields cause INVALID\_DATA errors.
>
> **trigger** `array`
>
> List of automation triggers to execute during update. Valid values: \['workflow', 'approval', 'blueprint', 'pathfinder', 'orchestration']. Pass empty array \[] to skip all automation. If not specified, default triggers execute. Example: \['workflow', 'blueprint']
>
> **module\_api\_name** `string` *required*
>
> The API name of the module to update records in. Standard modules use PascalCase (e.g., 'Leads', 'Contacts', 'Accounts', 'Deals', 'Tasks', 'Campaigns'). Custom modules must use their exact API name as configured in Zoho CRM.
>
> **skip\_feature\_execution** `array`
>
> Features to skip during the update. Example: \[\{'name': 'cadences'}] to skip cadence execution
>
> **apply\_feature\_execution** `array`
>
> Features to execute during the update. Example: \[\{'name': 'layout\_rules'}] or \[\{'name': 'criteria\_validation\_rule'}]
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Attachment to Zoho CRM Record
>
> **Slug:** `ZOHO_UPLOAD_ATTACHMENT`
>
> Tool to upload a file as an Attachment to a specific Zoho CRM record. Use when you need to store files (PDFs, documents, images) in a record's Attachments section.
>
> #### Input Parameters
>
> **file** `object`
>
> File to upload as an attachment.
>
> **title** `string`
>
> Deprecated. This field is ignored because remote URL attachments are not supported.
>
> **record\_id** `string` *required*
>
> The unique ID of the record to attach the file or URL to.
>
> **attachmentUrl** `string`
>
> Deprecated. Remote URL attachments are not supported because Zoho fetches the URL server-side.
>
> **module\_api\_name** `string` *required*
>
> The API name of the module containing the record. Examples: 'Leads', 'Contacts', 'Accounts', 'Deals', etc.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload Zoho CRM Record Photo
>
> **Slug:** `ZOHO_UPLOAD_RECORD_PHOTO`
>
> Set or replace the photo on a supported Zoho CRM record.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> PNG, JPEG, JPG, GIF, or BMP photo to upload. Zoho allows files up to 10 MB and images up to 10 megapixels.
>
> **record\_id** `string` *required*
>
> Unique ID of the record whose photo should be set or replaced.
>
> **module\_api\_name** `string` *required*
>
> API name of the standard or custom module containing the record, such as Leads, Contacts, Accounts, Deals, or Products.
>
> **restrict\_triggers** `string`
>
> Set to 'workflow' to prevent associated workflow rules from running. Omit to use Zoho's default trigger behavior.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upsert Zoho CRM Records
>
> **Slug:** `ZOHO_UPSERT_RECORDS`
>
> Insert or update up to 100 records using Zoho CRM duplicate matching.
>
> #### Input Parameters
>
> **data** `array` *required*
>
> One to 100 records to insert or update. Use exact CRM field API names as keys; mandatory and unique fields depend on the selected module.
>
> **trigger** `array`
>
> Automation triggers to run. Pass an empty list to suppress workflows, approvals, and blueprints; omit to use Zoho's defaults.
>
> **module\_api\_name** `string` *required*
>
> Exact API name of the Zoho CRM module, such as Leads, Contacts, Accounts, or a custom module API name.
>
> **if\_unmodified\_since** `string`
>
> ISO 8601 timestamp sent as If-Unmodified-Since. Zoho rejects the upsert if the record was modified after this time.
>
> **duplicate\_check\_fields** `array`
>
> Ordered field API names Zoho should use to find duplicates, such as Email and Phone. Omit to use Zoho's module defaults.
>
> **skip\_feature\_execution** `array`
>
> Cadence executions to skip for inserted or updated records. Each item must select cadences and either the insert or update outcome.
>
> **apply\_feature\_execution** `array`
>
> Additional CRM checks to apply. Supported features are layout rules and criteria validation rules.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate Zoho CRM Credentials
>
> **Slug:** `ZOHO_VALIDATE_CREDENTIAL`
>
> Validates Zoho CRM credentials by retrieving current user information. Returns user details if credentials are valid. Use this action when you need to verify that API credentials are working correctly before performing other operations. This is a read-only operation that confirms authentication without modifying any data.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
