Skip to main content
Zoho logo
  • Category: crm
  • Auth: OAUTH2
  • Composio-managed OAuth available? Yes
  • Tools: 103
  • Triggers: 0
  • Slug: ZOHO
  • Version: 20261103_00

Frequently Asked Questions

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.

Tools

Slug: ZOHO_ADD_TAGS_TO_RECORDSApply one or more existing tags to up to 500 records in a Zoho CRM module, optionally replacing each record’s existing tags.

Input Parameters

array
required
Existing tags to apply. Each tag must contain its id or name; when both are supplied, Zoho gives the id precedence.
boolean
Whether to replace each record’s existing tags. False adds these tags without removing existing tags.
array
required
IDs of the records to tag. Zoho accepts 1 to 500 IDs per request.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_ASSOCIATE_EMAILAdd an existing sent or received email to a Zoho CRM record’s history.

Input Parameters

array
Carbon-copy recipients of the email.
array
required
Primary recipients of the email.
array
Blind-carbon-copy recipients of the email.
boolean
required
Whether the email was sent by the owner. Use false for a received email.
object
Owner of the email when an administrator associates another user’s email.
string
required
Body of the existing email, as plain text or HTML.
string
required
Subject line of the existing email.
string
required
ISO 8601 date and time at which the email was sent or received.
string
required
Unique ID of the CRM record whose email history will be updated.
object
required
Sender name and email address.
array
Attachments previously uploaded to ZFS. Their combined size must not exceed 10 MB.
string
Set to html when content contains HTML markup or inline images.
object
An additional CRM record to map to the associated email.
string
required
Exact API name of the CRM module containing the record, such as Leads, Contacts, Deals, or a custom module API name.
string
required
Unique Message-ID value from the original email header.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CONVERT_ZOHO_LEADConverts a lead into a contact, account, and optionally a deal in Zoho CRM.

Input Parameters

object
Deal to create while converting the lead.
string
required
The unique ID of the lead to convert.
string
User ID to assign as the owner of the new contact/account.
boolean
Whether to overwrite the account name in the contact if it already exists and the company names mismatch.
string
ID of an existing account to associate with the converted lead.
string
ID of an existing contact to associate with the converted lead.
object
Tags to carry over to converted records.
boolean
Notify the lead owner about the conversion via email.
object
Module to which attachments from the lead should be moved.
boolean
Notify the new owner of the contact/account via email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_COUNT_RECORDSCount all records or records matching one filter in a Zoho CRM module.

Input Parameters

string
Word searched across record fields. Cannot be combined with another search filter or custom_view_id.
string
Email address used to count matching records. Cannot be combined with another search filter or custom_view_id.
string
Phone number used to count matching records. Cannot be combined with another search filter or custom_view_id.
string ("true" | "false" | "both")
Whether to count approved records: true, false, or both.
string
Zoho criteria expression used to count matching records. Cannot be combined with another search filter or custom_view_id.
string ("true" | "false" | "both")
Whether to count converted records: true, false, or both.
string
Custom view ID used to limit the count. Cannot be combined with criteria, email, phone, or word.
string
required
Exact API name of the module to count.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_AUTOMATION_TASKCreate an automation task with typed static, merge, date, or datetime mappings.

Input Parameters

string
required
Display name of the task.
object
required
Module whose automation creates the task.
string
Optional Zoho feature using this task definition. The only supported value is workflow.
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.
Zoho CRM module identity used by an automation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_CONTACTCreates 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

string
Fax number of the contact
string
Email address of the contact
object
Reference to another contact or user in Zoho CRM.
string
Phone number of the contact
string
Job title of the contact
string
Assignment rule ID. Kept as a string to preserve Zoho’s 19-digit IDs safely.
string
Mobile phone number of the contact
array
Automation triggers to execute during creation.
string
Twitter handle of the contact
string
Skype ID of the contact
string
Name of the contact’s assistant
string
required
Last name of the contact (required field, must be non-empty)
string
ZIP code for other address
string
Phone number of the contact’s assistant
string
Department where the contact works
string
First name of the contact
string
Home phone number of the contact
string
City for other address
string
Description or notes about the contact
string
Source from which the contact was acquired
string
ZIP code for mailing address
string
Alternative phone number of the contact
string
State for other address
string
Name of the vendor associated with this contact
string
Name of the account associated with this contact
string
City for mailing address
string
Street address for other address
object
Reference to another contact or user in Zoho CRM.
string
Date of birth of the contact in YYYY-MM-DD format
string
State for mailing address
string
Country for other address
string
Street address for mailing
string
Country for mailing address
string
Secondary email address of the contact
array
Features to skip during creation, such as cadences.
array
Features to execute during creation, such as layout_rules or criteria_validation_rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_CUSTOM_FIELDCreate one to five custom fields in a Zoho CRM module.

Input Parameters

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.
string
required
Required exact API name of the module that will receive the custom fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_CUSTOM_VIEWCreate one custom view for a Zoho CRM module.

Input Parameters

string
required
Name of the custom view.
array
required
One to 250 fields displayed in the custom view, with optional pin, pixel-width, and pin-order configuration.
boolean
Whether the custom view is locked.
object
Field reference used to sort the custom view, or null for no sort.
string ("public_views" | "other_users_views" | "shared_with_me" | "created_by_me")
Documented category used to organize the custom view.
string
A typed field criterion or nested group. Pass null to return all records.
integer
Favorite order, or null to leave the view out of favorites.
array
Users, roles, groups, or territories that can access a shared view.
boolean
Whether text wrapping is enabled for the custom view.
string ("asc" | "desc")
Sort direction, or null for no sort order.
string ("shared" | "public" | "only_to_me")
required
Who can access the custom view.
array
Up to three filters over records in related modules.
string
required
API name of the Zoho CRM module that will own the custom view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_DEALCreates 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

object
Owner of the deal.
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’.
number
The monetary value of the deal in the account’s currency. Use decimal format for fractional amounts.
string
Assignment rule ID. Kept as a string to preserve Zoho’s 19-digit IDs safely.
array
Automation triggers to execute during creation.
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.
string
required
The name of the deal. This is a required field and must be a non-empty string.
string
The next action or step planned for moving this deal forward in the sales process.
string
A detailed description or notes about the deal, including context, requirements, or special considerations.
string
The source or channel from which this deal originated.
integer
The probability of closing this deal, expressed as a percentage between 0 and 100.
object
Account associated with the deal.
string
The expected or actual closing date of the deal in YYYY-MM-DD format (ISO 8601 date format).
object
Contact associated with the deal.
object
Campaign associated with the deal.
array
Features to skip during creation, such as cadences.
array
Features to execute during creation, such as layout_rules or criteria_validation_rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_EMAIL_DRAFTCreates 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

string
required
Unique identifier of the record for which to create the email draft
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_EVENTCreates 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

object
Reference to another record in the CRM.
string
Location or venue of the event
object
Contact associated with the event; relate Leads through What_Id instead.
boolean
Indicates whether the event spans an entire day or multiple days
object
Reference to a business record related to the event.
array
List of supported automation triggers to invoke. Use cautiously because triggers can cause side effects such as sending emails.
array
List of reminder configurations for the event. Each reminder specifies when to alert before the event starts
string
Detailed description of the event
string
required
Name of the event. Required field that accepts alphanumeric and special characters
string
required
Event end date and time in ISO8601 format (e.g., ‘2024-07-03T14:30:00+05:30’)
array
List of event participants (leads, contacts, users, or email addresses)
string
required
Event start date and time in ISO8601 format (e.g., ‘2024-07-03T12:30:00+05:30’)
string
Check-in status for the event
object
Recurrence rule for the event in RRULE format.
array
Features to skip during creation, such as cadences.
array
Features to execute during creation, such as layout_rules or criteria_validation_rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_FUNCTIONCreate 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

string
required
Function display name. Must start with a letter and contain only letters, digits, spaces, hyphens, and underscores (3-100 characters).
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.
string
required
Unique function API name. Must start with a letter and contain only letters, digits, hyphens, and underscores (3-100 characters).
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.
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.
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.
string
Optional function description, up to 3000 characters.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_LEADCreates 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

string
Fax number of the lead
string
City of the lead’s address
string
Email address of the lead
string
Phone number of the lead (up to 30 characters)
string
State or province of the lead’s address
string
Mobile phone number of the lead
string
Rating of the lead (e.g., Acquired, Active, Market Failed, Project Cancelled, Shutdown)
string
Street address of the lead
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
string
Company name associated with the lead
string
Country of the lead’s address
string
Twitter handle of the lead
string
Website URL of the lead’s company
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.
string
Industry sector of the lead’s company
string
Skype ID of the lead
string
Postal or ZIP code of the lead’s address
string
required
Last name of the lead - this is a mandatory field in Zoho CRM
string
First name of the lead
string
Salutation or title for the lead (e.g., Mr., Ms., Dr., Prof.)
string
Additional notes or description about the lead
string
Job title or designation of the lead
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)
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)
number
Annual revenue of the lead’s company
integer
Number of employees in the lead’s company
string
Secondary email address of the lead
array
Features to skip during creation, such as cadences.
array
Features to execute during creation, such as layout_rules or criteria_validation_rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_NOTECreates 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

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.
string
Optional title for the note
string
required
The content/text of the note (required)
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.
boolean
Whether the note is shared with the client.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_WORKFLOW_RULECreate one Zoho CRM workflow rule with typed triggers, criteria, and actions.

Input Parameters

object
required
The one workflow rule to create in this request.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_ZOHO_RECORDCreates 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

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.
string
Assignment rule ID to apply when creating records. Kept as a string to preserve Zoho’s 19-digit IDs safely.
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.
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.
array
Features to skip during creation, such as cadences.
array
Features to execute during creation, such as layout_rules or criteria_validation_rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_CREATE_ZOHO_TAGCreates 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

string
required
The name of the tag to create. Maximum 25 characters. Cannot contain ’<’, ’>’, commas, or emojis.
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).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_ACCOUNTDeletes 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

string
required
The unique identifier of the account to delete. Must be a valid Zoho CRM account ID.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_CONTACTDeletes a contact from Zoho CRM by its ID, with an optional workflow trigger setting.

Input Parameters

string
required
The unique identifier of the contact to delete
boolean
Whether to trigger workflows during deletion. If true, all associated workflows execute. Defaults to true if not specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_DEALDeletes 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

string
required
The unique identifier of the deal to delete. This is the Zoho CRM record ID for the deal
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_EMAIL_DRAFTDelete one unsent email draft associated with a Zoho CRM record.

Input Parameters

string
required
Unique identifier of the email draft to delete.
string
required
Unique identifier of the record containing the draft.
string
required
API name of the module containing the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_EVENTMove 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

string
required
The unique Zoho CRM record ID of the event to delete.
boolean
Whether to execute workflow rules during deletion. Zoho defaults an omitted value to true, so workflows and notifications can run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_LEADMove one Zoho CRM Lead record to the recycle bin.

Input Parameters

string
required
The unique Zoho CRM record ID of the lead to delete.
boolean
Whether to execute workflow rules during deletion. If omitted, Zoho’s default behavior applies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_NOTEMove one Zoho CRM note to the recycle bin.

Input Parameters

string
required
The unique Zoho CRM record ID of the note to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_RECORDSMove up to 100 records from a Zoho CRM module to the recycle bin.

Input Parameters

array
required
The IDs of 1 to 100 records to move to the recycle bin.
boolean
Whether to execute workflow rules during deletion. If omitted, Zoho’s default behavior applies.
string
required
The API name of the standard or custom Zoho CRM module containing the records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DELETE_TAGDelete one Zoho CRM tag definition by its tag ID.

Input Parameters

string
required
The unique ID of the Zoho CRM tag definition to delete.

Output

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

Input Parameters

string
required
Unique ID of the Zoho CRM record containing the attachment.
string
required
Unique attachment ID returned by ZOHO_LIST_RECORD_ATTACHMENTS or ZOHO_UPLOAD_ATTACHMENT.
string
required
API name of the module containing the record, such as Leads, Contacts, Accounts, or Deals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DOWNLOAD_RECORD_EMAIL_ATTACHMENTDownload one attachment from an email associated with a CRM record.

Input Parameters

string
required
Attachment name exactly as returned in the email’s attachments array.
string
required
Unique ID of the Zoho CRM user who sent the email.
string
required
Unique ID of the Zoho CRM record associated with the email.
string
required
Message ID returned by the send-mail or record-email retrieval action.
string
required
Unique attachment ID from the attachments array returned for the email. This is sent as Zoho’s id query parameter.
string
required
API name of the module containing the record, such as Leads, Contacts, Accounts, or Deals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_DOWNLOAD_RECORD_PHOTODownload the binary profile photo attached to a supported CRM record.

Input Parameters

string
required
Unique ID of the Zoho CRM record whose profile photo to download.
string
required
Supported Zoho CRM module API name containing the record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_EXPORT_AUDIT_LOGSExport Zoho CRM audit logs and return the completed CSV or ZIP file.

Input Parameters

string
Optional documented audit-log filter. Omit it to export up to the last three years of audit logs across all modules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_ACCOUNTRetrieves 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

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).
string
required
The unique identifier of the Account record to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_ASSIGNMENT_RULERetrieve one assignment rule and its module-specific configuration.

Input Parameters

string
required
API name of the CRM module that owns the assignment rule.
string
required
Unique numeric ID of the assignment rule to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_AUTOMATION_TASKRetrieve one configured Zoho CRM automation task and its field mappings.

Input Parameters

string
required
Unique ID of the configured Zoho CRM automation task.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_BLUEPRINTRetrieve one Zoho CRM blueprint and optional configuration details.

Input Parameters

string ("state" | "transition")
Additional blueprint configuration to include: state for states or transition for transitions.
string
required
The unique ID of the Zoho CRM blueprint to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_BLUEPRINT_TRANSITIONRetrieve one Zoho CRM blueprint transition and its configuration.

Input Parameters

string
required
Unique ID of the Zoho CRM blueprint transition to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_CALLRetrieves 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

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.
string
required
The unique identifier of the Call record to retrieve. Must be a valid Zoho CRM record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_CONTACTRetrieves 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

string
Comma-separated field API names to include in the response.
string
required
The unique ID of the contact record to retrieve. Must be a valid Zoho CRM contact record ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_CUSTOM_VIEWSList custom views for a Zoho CRM module or inspect one view by ID.

Input Parameters

string
The unique ID of one custom view. Omit this value to list all custom views for the module.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_DEALRetrieve one Zoho CRM Deal by record ID without a field projection.

Input Parameters

string
required
Unique ID of the Zoho CRM Deal record to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_EMAIL_DRAFTSRetrieves 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

integer
Page number to retrieve when listing drafts. Starts at 1.
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.
string
required
Entity ID of the record for which to retrieve email drafts.
string
Unique email draft ID to retrieve. When provided, pagination parameters are ignored and only this draft is returned.
integer
Number of drafts to retrieve per collection page, from 1 to 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_EVENTRetrieves 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

string
Comma-separated field API names to include in the response.
string
required
The unique identifier of the event record to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_FROM_ADDRESSESRetrieves 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_KIOSK_STATESList a kiosk’s states or retrieve one state and its associated elements.

Input Parameters

string
required
Unique ID of the Zoho CRM kiosk.
string
Unique state ID. Omit to list all states in the kiosk.
boolean
Whether list results should include configured merge-field properties. This option is ignored when state_id is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_LAYOUTSList layouts for a CRM module or retrieve one complete layout definition.

Input Parameters

string
Unique layout ID. Omit to list all layouts for the module.
string
required
Exact API name of the CRM module whose layouts to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_MODULE_FIELDSRetrieves 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

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.
string
Include additional permission details in the response. Use ‘allowed_permissions_to_update’ to get default field permissions (read-only, read-write, hidden).
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_NOTERetrieves 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

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.
string
required
The unique identifier of the note to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_ORGANIZATION_DETAILSRetrieve identity, locale, currency, contact, and license metadata for the connected Zoho CRM organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_PIPELINESRetrieve pipeline and stage configuration for a Zoho CRM Deals layout.

Input Parameters

string
required
Unique numeric ID of the Zoho CRM Deals layout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_PRODUCTRetrieve one Zoho CRM Product by record ID.

Input Parameters

string
Comma-separated API names of Product fields to retrieve. Omit this value to retrieve all available fields.
string
required
The unique ID of the Zoho CRM Product record to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_PROFILERetrieve one Zoho CRM permission profile and its expanded permissions.

Input Parameters

string
required
Unique Zoho CRM permission profile ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_RECORDRetrieve 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

string
Comma-separated API names of fields to retrieve. Omit to let Zoho return all fields available through this endpoint.
string
required
Unique ID of the record in the selected module.
string
required
Exact API name of the standard or custom CRM module.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_RECORD_EMAILRetrieve one email associated with a Zoho CRM record, including its body.

Input Parameters

string
ID of the email owner. Required when viewing another user’s shared email; omit when viewing your own email.
string
required
Unique ID of the CRM record related to the email.
string
required
Message ID returned by the record email collection action.
string
required
Exact API name of the module containing the related record.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_RECORD_EMAILSRetrieves 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

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.
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.
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.
string
required
The unique identifier of the record whose emails you want to retrieve.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_RECORD_TIMELINERetrieve chronological field and related-record history for a Zoho CRM record.

Input Parameters

object
Structured Zoho timeline filter object. It is encoded as compact JSON in the filters query parameter.
string ("extension" | "type")
Additional timeline category to include in the response.
string
Sort timeline entries by their audited timestamp.
integer
Number of timeline entries to return on the first page (1-200). Cannot be used with page_token.
string
required
Unique ID of the Zoho CRM record whose timeline to retrieve.
string
Token from info.next_page_token. When supplied, per_page must be omitted.
string
required
Exact API name of the Zoho CRM module containing the record.
array
Additional field-history or actor details to include.
string
Timeline type to include. The include parameter is required when this is supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_TASKRetrieves 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

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.
string
required
The unique identifier of the task to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_USERRetrieves 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_WEBFORMRetrieve one configured Zoho CRM webform by ID.

Input Parameters

string
Optional analytics range end in DD-MM-YYYY HH:MM:SS format.
string
Optional analytics range start in DD-MM-YYYY HH:MM:SS format.
string
required
Unique ID of the webform to retrieve.
string
required
Exact API name of the module that owns the webform.
boolean
Whether to include active-user inner details in the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_WORKFLOW_RULERetrieve one Zoho CRM workflow rule and its complete configuration.

Input Parameters

string
required
Unique ID of the Zoho CRM workflow rule to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_ZOHO_RECORDSRetrieves 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

string
Comma-separated record IDs to fetch specific records. When continuing with page_token, provide the same IDs used for the original request.
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.
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.
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.
string ("id" | "Created_Time" | "Modified_Time")
Valid fields for sorting Zoho CRM records.
integer
Number of records per page (default and max is 200). Applies to both page and page_token pagination.
string ("false" | "true" | "both")
Filter by conversion status: ‘true’, ‘false’, or ‘both’.
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.
string ("asc" | "desc")
Sort order for records.
string
Territory ID used to filter records, represented as a string.
boolean
Whether to include records from child territories when territory_id is provided.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_GET_ZOHO_USERSTool 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

string
Comma-separated list of user IDs to retrieve specific users. Maximum of 100 user IDs can be specified at once.
integer
Page number to retrieve for paginated results. Default is 1.
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.
string
Portal user type to retrieve. Zoho currently supports ‘Client Portal User’.
integer
Number of users to retrieve per page. Maximum is 200. Default is 200.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_ACCESS_SETTINGSList roles or permission profiles configured in Zoho CRM.

Input Parameters

string ("roles" | "profiles")
required
Access-settings collection to list: roles or profiles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_ACCOUNTSRetrieves 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

string
Comma-separated account record IDs to retrieve. When using page_token, this must match the original query.
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.
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.
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.
string ("id" | "Created_Time" | "Modified_Time")
Valid fields for sorting Zoho CRM Accounts records.
string
Filter accounts by approval status: ‘true’ for approved, ‘false’ for not approved, ‘both’ for all.
integer
Number of account records per page (max is 200). Default is 25 to avoid token bloat.
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.
string ("asc" | "desc")
Sort order for Accounts records.
string
Territory ID to filter accounts by territory assignment, represented as a string.
boolean
Whether to include accounts from child territories when territory_id is specified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_CADENCESList Zoho CRM cadence definitions using optional filters.

Input Parameters

string
Cadence-name JSON filter expression using equal, not_equal, contains, not_contains, starts_with, or ends_with. The HTTP transport URL-encodes it.
integer
Page number to retrieve from the cadence list.
boolean
Whether to return only active or only inactive cadences.
string
Set to name to request only cadence names.
integer
Number of cadence records to retrieve per page.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_CALLSRetrieves 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

string
Comma-separated Call record IDs to fetch specific records. When using page_token, this must match the original query.
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.
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.
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.
string ("id" | "Created_Time" | "Modified_Time")
Valid fields for sorting Zoho CRM Call records.
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.
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.
string ("asc" | "desc")
Sort order for Call records.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_CONNECTED_WORKFLOW_RULESList trigger conditions for a module’s rules in a connected workflow.

Input Parameters

string
required
API name of the CRM module whose connected-workflow rules to return.
string
required
Unique ID of the connected workflow whose rules to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_CONTACTSRetrieves 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

string
Comma-separated contact record IDs to fetch specific contacts. When using page_token, this must match the original query.
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.
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.
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.
string ("id" | "Created_Time" | "Modified_Time")
Valid fields for sorting Zoho CRM contact records.
integer
Number of contact records per page. Maximum is 200. Applies to both page and page_token pagination.
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.
string ("asc" | "desc")
Sort order for contact records.
string
Territory ID used to filter contacts, represented as a string.
boolean
Whether to include contacts from child territories when territory_id is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_DEALSRetrieves 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

string
Comma-separated deal IDs to fetch specific deals. When using page_token, this must match the original query.
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.
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.
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.
string ("id" | "Created_Time" | "Modified_Time")
Valid fields for sorting Zoho CRM deals.
integer
Number of deals per page (default 25, max is 200). Applies to both page and page_token pagination.
string ("false" | "true" | "both")
Filter by conversion status: ‘true’, ‘false’, or ‘both’.
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.
string ("asc" | "desc")
Sort order for deals.
string
Territory identifier to filter deals by territory, represented as a string.
boolean
Include child territory records (default: false). Only applicable when territory_id is provided.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_EVENTSLists 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

string
Comma-separated event record IDs to fetch specific events. When using page_token, this must match the original query.
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.
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.
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.
string ("id" | "Created_Time" | "Modified_Time")
Valid fields for sorting Zoho CRM Events.
integer
Number of events per page (max 200). Default: 25. Applies to both page and page_token pagination.
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.
string ("asc" | "desc")
Sort order for events.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_FUNCTIONSList configured Zoho CRM functions and their metadata.

Input Parameters

integer
Page number to retrieve within the first 2,000 functions. Do not use with page_token; page_token takes precedence when provided.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_LEADSRetrieves 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

string
Comma-separated lead record IDs to fetch specific leads. When using page_token, this must match the original query.
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.
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.
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.
string ("id" | "Created_Time" | "Modified_Time")
Valid fields for sorting Zoho CRM leads.
integer
Number of leads per page. Maximum is 200. Applies to both page and page_token pagination.
string ("true" | "false" | "both")
Filter leads by conversion status.
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.
string ("asc" | "desc")
Sort order for leads.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_MODULESLists 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

array
Module statuses to include. Multiple values are sent as a comma-separated query value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_NOTESRetrieves 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

integer
Page number to retrieve. Default is 1.
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’
integer
Number of notes per page. Default is 25, maximum is 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_RECORD_ATTACHMENTSTool 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

integer
Page number to retrieve (default: 1).
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.
integer
Number of attachments per page (default and maximum: 200).
string
required
The unique ID of the record to list attachments for.
string
required
The API name of the module containing the record. Examples: ‘Leads’, ‘Contacts’, ‘Accounts’, ‘Deals’, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_TAGSList the tags available for a Zoho CRM module.

Input Parameters

boolean
Whether to return only tags created by the current user. When omitted, Zoho uses its default of false.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_TASKSRetrieves 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

string
Comma-separated task IDs to fetch specific tasks. When using page_token, this must match the original query.
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.
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.
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.
string ("id" | "Created_Time" | "Modified_Time")
Valid fields for sorting Zoho CRM tasks.
integer
Number of tasks per page (default 25, max 200). Applies to both page and page_token pagination.
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.
string ("asc" | "desc")
Sort order for tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_VARIABLESList Zoho CRM configuration variables and their current values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_LIST_WORKFLOW_RULESList and filter workflow rules configured in Zoho CRM.

Input Parameters

integer
One-based page number to return.
string
API name of the primary CRM module whose workflow rules to return.
integer
Number of workflow rules to return per page, from 1 through 200.
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.
string ("asc" | "desc")
Sort rules by modified_time in ascending or descending order.
string
Return workflow rules whose name contains this value.
boolean
Whether to return only active rules (true) or only inactive rules (false).
string
API name of the related module that triggers the workflow rule. Requires module.
boolean
Whether to include conditions, criteria details, instant actions, and scheduled actions. Requires module.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_MERGE_LEADSMerge duplicate leads into a retained master lead and delete the child leads.

Input Parameters

array
required
One or two duplicate leads to merge into the master lead.
string
required
Unique ID of the master lead that will be retained.
array
Optional fields whose values should be retained from the master lead.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_ACCOUNTSSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
string
Global search keyword across multiple fields in the Accounts module. Cannot be used together with criteria or phone parameters.
string
Search for this phone number across all phone fields in the Accounts module. Cannot be used together with criteria or word parameters.
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.
string ("true" | "false" | "both")
Filter by approval status: true, false, or both.
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.
integer
Number of records per page. Maximum is 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_CALLSSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
string
Global search keyword across multiple fields in Call records. Cannot be used together with criteria.
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’.
string ("true" | "false" | "both")
Filter by approval status: true, false, or both.
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).
integer
Number of records per page. Maximum is 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_CONTACTSSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
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.
string
Search for this email address across all email fields in Contacts. Cannot be used together with criteria, phone, or word parameters.
string
Search for this phone number across all phone fields in Contacts. Cannot be used together with criteria, email, or word parameters.
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’.
string ("true" | "false" | "both")
Filter by approval status: true, false, or both.
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.
integer
Number of records per page. Default is 25, maximum is 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_DEALSSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
string
Global search keyword across multiple fields in Deals module. Cannot be used together with criteria.
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’.
string ("true" | "false" | "both")
Filter by approval status: true, false, or both.
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.
integer
Number of records per page. Maximum is 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_EVENTSSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
string
Global search keyword across multiple fields in Events module. Cannot be used together with criteria.
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’.
string ("true" | "false" | "both")
Filter by approval status: true, false, or both.
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.
integer
Number of records per page. Maximum is 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_LEADSSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
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.
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.
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.
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.
string ("true" | "false" | "both")
Filter for approved record status.
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.
integer
Number of records per page. Maximum is 200.
string ("true" | "false" | "both")
Filter for converted lead status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_NOTESSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
string
Global search keyword across multiple note fields including Note_Title and Note_Content. Cannot be used together with criteria.
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’.
string ("true" | "false" | "both")
Filter by approval status: true, false, or both.
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.
integer
Number of records per page. Maximum is 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_TASKSSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
string
Global search keyword across multiple fields in the Tasks module. Cannot be used together with criteria.
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’.
string ("true" | "false" | "both")
Filter by approval status: true, false, or both.
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.
integer
Number of records per page. Default is 25, maximum is 200.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_SEARCH_ZOHO_RECORDSSearch 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

integer
Page number to retrieve (default: 1). Maximum 2,000 records are accessible via search API. Maximum page number is floor(2000/per_page).
string
Global search keyword across multiple fields in the module. Cannot be used together with criteria, email, or phone parameters.
string
Search for this email address across all email fields in the module. Cannot be used together with criteria, phone, or word parameters.
string
Search for this phone number across all phone fields in the module. Cannot be used together with criteria, email, or word parameters.
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’.
string ("true" | "false" | "both")
Filter by approval status: true, false, or both.
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).
integer
Number of records per page. Default and maximum is 200.
string ("true" | "false" | "both")
Filter conversion status for modules that support conversion, such as Leads.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_ACCOUNTUpdates 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

string
Fax number for the account
object
Owner lookup field, formatted as {‘id’: ‘zoho_user_id’}. Use the Zoho user ID, not email or display name
string
Primary phone number for the account
string
Rating of the account (e.g., ‘Active’, ‘Market Failed’, ‘Project Cancelled’, ‘Shutdown’)
string
Company website URL
array
Automation triggers to execute during update.
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’)
string
Standard Industrial Classification Code
integer
Number of employees at the company
string
Ownership type (e.g., ‘Public’, ‘Private’, ‘Subsidiary’, ‘Other’)
string
required
Unique identifier of the Account record to update
string
Additional notes or description about the account
string
Name of the account/company
string
Account site or location identifier
string
Type/category of the account (e.g., ‘Analyst’, ‘Competitor’, ‘Customer’, ‘Integrator’, ‘Investor’, ‘Partner’, ‘Press’, ‘Prospect’, ‘Reseller’, ‘Other’)
string
City for billing address
string
Postal/ZIP code for billing address
string
State/province for billing address
string
City for shipping address
string
Postal/ZIP code for shipping address
string
Stock ticker symbol (if publicly traded)
integer
Account number or identifier (numeric value)
number
Annual revenue of the company
string
Street address for billing
object
Parent account lookup field, formatted as {‘id’: ‘parent_account_id’}
string
State/province for shipping address
string
Country for billing address
string
Street address for shipping
string
Country for shipping address
array
Features to skip during update, such as cadences.
array
Features to execute during update, such as layout_rules or criteria_validation_rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_CALLUpdates 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

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’}]
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’]
array
Features to skip during the update. Example: [{‘name’: ‘cadences’}] to skip cadence execution
array
Features to execute during the update. Example: [{‘name’: ‘layout_rules’}] or [{‘name’: ‘criteria_validation_rule’}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_CUSTOM_FIELDSUpdate custom-field definitions; some changes can alter existing record values.

Input Parameters

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.
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_CUSTOM_VIEWUpdate the configuration of one Zoho CRM custom view.

Input Parameters

string
New name for the custom view.
array
Up to 250 displayed fields with optional pin, pixel width, and pin-order configuration.
boolean
Whether the custom view is locked.
object
Field reference used to sort the view, such as an object containing api_name and id. Pass null to remove sorting.
string ("public_views" | "other_users_views" | "shared_with_me" | "created_by_me")
Documented category used to organize the custom view.
string
A typed field criterion or nested group. Pass null to remove all criteria and return all records.
integer
Favorite order, or null to remove the view from favorites.
array
Optional users, roles, groups, or territories that can access the view. Pass null to clear an existing sharing list.
string ("asc" | "desc")
Sort direction. Pass null when removing sorting.
string ("shared" | "public" | "only_to_me")
Who can access the custom view.
array
Up to three filters over related-module records. Pass null to remove all cross filters.
string
required
Unique ID of the custom view to update.
string
required
API name of the Zoho CRM module that owns the custom view.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_DEALUpdates 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

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.
string
required
The unique identifier of the deal to update. This is the Zoho CRM record ID.
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’]
array
Features to skip during the update. Example: [{‘name’: ‘cadences’}] to skip cadence execution
array
Features to execute during the update. Example: [{‘name’: ‘layout_rules’}] or [{‘name’: ‘criteria_validation_rule’}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_EMAIL_DRAFTUpdates 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

string
required
Unique identifier of the record to which the email draft is associated
array
required
Email draft objects to update, from 1 to 100 per request
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_EVENTUpdates 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

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.
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’]
array
Features to skip during update, such as cadences.
array
Features to execute during update, such as layout_rules or criteria_validation_rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_LAYOUTUpdate a custom layout’s metadata, profile access, sections, or fields.

Input Parameters

object
required
Layout changes. This action supports renaming, business-card visibility, profile access changes, and section or field configuration changes.
string
required
Unique numeric ID of the custom layout to update.
string
required
Exact API name of the CRM module that owns the layout.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_LEADUpdates 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

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.
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’]
array
Features to skip during the update. Example: [{‘name’: ‘cadences’}] to skip cadence execution
array
Features to execute during the update. Example: [{‘name’: ‘layout_rules’}] or [{‘name’: ‘criteria_validation_rule’}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_NOTEUpdates an existing Zoho CRM note by ID, including its title, content, or portal-user sharing setting.

Input Parameters

string
required
The unique identifier of the note to update
string
Updated title of the note. If not provided, the existing title remains unchanged.
string
Updated content/body of the note. If not provided, the existing content remains unchanged.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_USERUpdate a Zoho CRM user’s name, email, contact details, locale, time preferences, role, profile, or status by ID.

Input Parameters

object
required
Supported user settings to update.
string
required
ID of the CRM user to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_WEBFORMReplace one Zoho CRM webform configuration using the V8 path-ID route.

Input Parameters

object
required
Complete replacement configuration for the webform.
string
required
Unique ID of the webform selected by the request path.
string
required
Module API name sent in the mandatory module query parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_WORKFLOW_RULEUpdate a Zoho CRM workflow rule’s name, description, or activation status by ID.

Input Parameters

string
required
Unique ID of the workflow rule to update.
object
required
Changes to the workflow rule’s name, description, or activation status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPDATE_ZOHO_RECORDUpdates 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

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.
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’]
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.
array
Features to skip during the update. Example: [{‘name’: ‘cadences’}] to skip cadence execution
array
Features to execute during the update. Example: [{‘name’: ‘layout_rules’}] or [{‘name’: ‘criteria_validation_rule’}]

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPLOAD_ATTACHMENTTool 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

object
File to upload as an attachment.
string
Deprecated. This field is ignored because remote URL attachments are not supported.
string
required
The unique ID of the record to attach the file or URL to.
string
Deprecated. Remote URL attachments are not supported because Zoho fetches the URL server-side.
string
required
The API name of the module containing the record. Examples: ‘Leads’, ‘Contacts’, ‘Accounts’, ‘Deals’, etc.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPLOAD_RECORD_PHOTOSet or replace the photo on a supported Zoho CRM record.

Input Parameters

object
required
PNG, JPEG, JPG, GIF, or BMP photo to upload. Zoho allows files up to 10 MB and images up to 10 megapixels.
string
required
Unique ID of the record whose photo should be set or replaced.
string
required
API name of the standard or custom module containing the record, such as Leads, Contacts, Accounts, Deals, or Products.
string
Set to ‘workflow’ to prevent associated workflow rules from running. Omit to use Zoho’s default trigger behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_UPSERT_RECORDSInsert or update up to 100 records using Zoho CRM duplicate matching.

Input Parameters

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.
array
Automation triggers to run. Pass an empty list to suppress workflows, approvals, and blueprints; omit to use Zoho’s defaults.
string
required
Exact API name of the Zoho CRM module, such as Leads, Contacts, Accounts, or a custom module API name.
string
ISO 8601 timestamp sent as If-Unmodified-Since. Zoho rejects the upsert if the record was modified after this time.
array
Ordered field API names Zoho should use to find duplicates, such as Email and Phone. Omit to use Zoho’s module defaults.
array
Cadence executions to skip for inserted or updated records. Each item must select cadences and either the insert or update outcome.
array
Additional CRM checks to apply. Supported features are layout rules and criteria validation rules.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ZOHO_VALIDATE_CREDENTIALValidates 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

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