Zoho CRM

1. Overview

Zoho CRM is a comprehensive cloud-based Customer Relationship Management (CRM) platform that helps businesses manage their sales, marketing, customer support, and inventory operations. It provides tools for lead management, contact organization, deal tracking, sales automation, and detailed analytics.

Through the GoInsight Zoho CRM node, you can seamlessly integrate CRM operations into your automated workflows. You can manage the full lifecycle of your sales data, including:

• Create and manage leads, contacts, accounts, and deals
• Track and update sales opportunities, quotes, and orders
• Search and retrieve CRM records with flexible filtering
• Organize products, invoices, and vendor information
• Extend functionality with custom modules and field management

2. Prerequisites

Before using this node, you need to have a valid Zoho CRM account. You may need administrator permissions to create and manage API credentials and OAuth applications.

3. Credentials

For detailed guidance on how to obtain and configure credentials, please refer to our official documentation: Credentials Configuration Guide.

4. Supported Operations

Summary

This node primarily operates on various resources within Zoho CRM, including Leads, Contacts, Accounts, Deals, Products, Quotes, Sales Orders, Purchase Orders, Invoices, Vendors, and Modules. The following table provides a complete overview of all supported operations:

Operation Details

Create a Lead

Creates a single lead in Zoho CRM

Input Parameters:

• LastName: The last name (family name) of the lead (required). This is the only required field for creating a lead in Zoho CRM. Example: 'Smith', 'Zhang'.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region:
• EU region: https://www.zohoapis.eu
• China region: https://www.zohoapis.com.cn
• India region: https://www.zohoapis.in
• Australia region: https://www.zohoapis.com.au
• FirstName: The first name (given name) of the lead (optional). Example: 'John', 'Wei'.
• Company: The company or organization name of the lead (optional). For B2B sales, this is typically the prospect's employer. Example: 'Acme Corporation', 'Tech Startup Inc.'.
• Email: The email address of the lead (optional). Format: user@domain.com. This field is commonly used for duplicate checking and email campaigns. Example: 'john.smith@company.com'.
• Phone: The phone number of the lead (optional). Accepts any format. Example: '+1-555-123-4567', '13800138000'.
• LeadSource: The source/origin of this lead (optional). Indicates how the lead was acquired.

Common Zoho CRM Lead Source values:

• 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
• Twitter
• Facebook

Note: Your Zoho CRM may have custom Lead Source values configured by your administrator.

• AdditionalFields: Additional lead fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Title": "CTO", "Industry": "Technology", "Rating": "Hot"}
• DuplicateCheckFields: Comma-separated list of field API names to check for duplicates before creating (optional). If a lead with matching values already exists, the API returns an error instead of creating a duplicate.

Common fields for duplicate check: Email, Phone, Mobile

Example: 'Email' or 'Email,Phone'

Note: Leave empty to skip duplicate checking. Recommended to use 'Email' for most cases to prevent duplicate leads on retry.

Output:

• CreatedLead (object): The created lead object containing id, First_Name, Last_Name, Company, Email, Phone, Created_Time, Modified_Time, Created_By, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 503/504 (network error), or other HTTP status codes.
• ErrorMessage (string): Detailed error description. Empty string when successful.

Create or Update a Lead

Creates or updates a lead in Zoho CRM

Input Parameters:

• LastName: The last name (family name) of the lead (required). This is the only required field for creating or updating a lead in Zoho CRM. Example: 'Smith', 'Zhang'.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region:
• EU region: https://www.zohoapis.eu
• China region: https://www.zohoapis.com.cn
• India region: https://www.zohoapis.in
• Australia region: https://www.zohoapis.com.au
• FirstName: The first name (given name) of the lead (optional). Example: 'John', 'Wei'.
• Company: The company or organization name of the lead (optional). For B2B sales, this is typically the prospect's employer. Example: 'Acme Corporation', 'Tech Startup Inc.'.
• Email: The email address of the lead (optional). Format: user@domain.com. This field is commonly used for duplicate checking and email campaigns. If a lead with the same email exists, it will be updated instead of creating a duplicate. Example: 'john.smith@company.com'.
• Phone: The phone number of the lead (optional). Accepts any format. Example: '+1-555-123-4567', '13800138000'.
• LeadSource: The source/origin of this lead (optional). Indicates how the lead was acquired.

Common Zoho CRM Lead Source values:

• 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
• Twitter
• Facebook

Note: Your Zoho CRM may have custom Lead Source values configured by your administrator.

• LeadId: The ID of the lead to update (optional). If provided, updates this specific lead directly, bypassing duplicate check. How to get this ID: Use 'Search Leads' or 'Get Many Leads' action to retrieve Lead IDs. Example: 3652397000000624001
• AdditionalFields: Additional lead fields as an object (optional). Use Zoho CRM field API names as keys. Common fields: Title (string), Industry (string), Annual_Revenue (number), No_of_Employees (number), Website (string), Mobile (string), Street/City/State/Zip_Code/Country, Description (string), Lead_Status (string), Rating (string). Example: {"Title": "CTO", "Industry": "Technology", "Rating": "Hot", "Website": "https://example.com"}
• DuplicateCheckFields: Comma-separated list of field API names to check for duplicates before creating (optional). If a lead with matching values already exists, it will be updated instead of creating a duplicate (upsert behavior).

Common fields for duplicate check: Email, Phone, Mobile

Example: 'Email' or 'Email,Phone'

Note: Leave empty to skip duplicate checking (will use Email by default for upsert). This parameter only applies when LeadId is NOT provided.

Output:

• CreatedOrUpdatedLead (object): The created or updated lead object containing:
• id (string): Unique identifier of the lead in Zoho CRM
• Created_Time (string): Creation timestamp in ISO 8601 format
• Modified_Time (string): Last modification timestamp
• Created_By (object): User who created the record, contains 'id' and 'name'
• Owner (object): Lead owner, contains 'id' and 'name'
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), or HTTP status code for API errors.
• ErrorMessage (string): Detailed error description. Empty string when successful. Contains upstream API error details for debugging.

Delete a Lead

Deletes a lead from Zoho CRM

Input Parameters:

• LeadId: The unique ID of the lead to delete (required). Obtain from Search Leads or Get Many Leads workflow. Format: Zoho-generated numeric string. Example: '4150868000001234567'

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).

Output:

• DeletedLead (object): Deleted lead object containing: id (string: deleted lead ID), status (string: always 'deleted')
• StatusCode (number): The HTTP status code of the API request.
• ErrorMessage (string): Any error message that occurred during the execution.

Get Lead Fields

Retrieves the fields of the Leads module from Zoho CRM

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).

Output:

• Fields (object-array): Array of field objects. Each contains api_name (API field name), display_label (UI display name), data_type (field type), and required (boolean).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 503/504 (network error), or other HTTP status codes.
• ErrorMessage (string): Detailed error description. Empty string when successful.

Get Many Leads

Retrieves many leads from Zoho CRM

Options:

• ZohoUrl: The base URL of the Zoho CRM API. Default is https://www.zohoapis.com for US datacenter. For other regions: EU (https://www.zohoapis.eu), IN (https://www.zohoapis.in), AU (https://www.zohoapis.com.au), CN (https://www.zohoapis.com.cn).
• PerPage: Number of leads to retrieve per page. Valid range: 1-200. Default is 200 for maximum efficiency.
• Page: Page number to retrieve (1-based). Use with PerPage for pagination. Check Info.more_records in response to determine if more pages exist.
• AdditionalFields: Comma-separated list of additional field API names to include in the response. Leave empty to use default fields (Id, First_Name, Last_Name, Full_Name, Email, Phone, Mobile, Company, Title, Lead_Source, Lead_Status, Industry, Annual_Revenue, Street, City, State, Country, Zip_Code, Owner, Created_Time, Modified_Time). Use "*" to retrieve all available fields (may impact performance).

Output:

• Leads (object-array): Array of Lead objects. Each object contains: Id (string, unique identifier), First_Name (string), Last_Name (string), Full_Name (string), Email (string), Phone (string), Mobile (string), Company (string), Title (string), Lead_Source (string), Lead_Status (string), Industry (string), Annual_Revenue (number), Street (string), City (string), State (string), Country (string), Zip_Code (string), Owner (object with id and name), Created_Time (string, ISO 8601), Modified_Time (string, ISO 8601). Additional fields depend on AdditionalFields parameter.
• Info (object): Pagination metadata object containing: per_page (number, records per page), page (number, current page), count (number, total records in current page), more_records (boolean, true if more pages exist). Use more_records to determine if you need to fetch the next page.
• StatusCode (number): HTTP status code: 200 (success), -1 (parameter validation error), 504 (timeout), 4xx (client error from Zoho API), 5xx (server error).
• ErrorMessage (string): Error message if the request failed, empty string on success. Contains detailed error from Zoho API when available.

Get a Lead

Retrieves a single lead from Zoho CRM

Input Parameters:

• LeadId: The ID of the lead to retrieve.

Options:

• ZohoUrl: The base URL of the Zoho CRM instance (e.g., https://www.zohoapis.com).
• Fields: Comma-separated list of field API names to retrieve (optional). Leave empty to retrieve all default fields. Example: Last_Name,Email,Phone

Output:

• Lead (object): The lead object containing id, Last_Name, First_Name, Email, Phone, Company, Lead_Source, Created_Time, Modified_Time, Created_By, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 404 (lead not found), 429 (rate limited), 503/504 (network error), or other HTTP status codes.
• ErrorMessage (string): Detailed error description. Empty string when successful.

Search Leads

Search leads in Zoho CRM using criteria, email, phone, or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Criteria: Search criteria expression (optional). Format: (Field:Operator:Value). Operators: equals, starts_with, contains, greater_than, less_than. Combine with 'and'/'or'. Example: (Last_Name:equals:Zhang)and(Lead_Status:equals:Hot). Priority: Criteria > Email > Phone > Keyword.
• Email: Search by email address (exact match).
• Phone: Search by phone number (exact match).
• Keyword: Keyword search (searches across multiple fields).
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number for pagination. Starts from 1. Default: 1.
• AdditionalFields: Comma-separated list of additional field API names to include in results (optional). Example: Custom_Field_1,Custom_Field_2

Output:

• Leads (object-array): Array of lead objects matching search criteria. Each object contains id, Last_Name, First_Name, Email, Phone, Mobile, Company, Lead_Source, Lead_Status, Owner, Created_Time, Modified_Time, and any additional fields requested.
• Info (object): Pagination metadata object with count (total records in response), more_records (boolean), per_page, and page.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 404 (no results), 429 (rate limited), 503/504 (network error), or other HTTP status codes.
• ErrorMessage (string): Detailed error description. Empty string when successful.

Update a Lead

Updates a lead in Zoho CRM

Input Parameters:

• LeadId: The unique ID of the lead to update (required). Obtain from: (1) Search Leads action with email/keywords, (2) Get Many Leads action, or (3) Create a Lead response (CreatedLead.id). Example: '3652397000000624001'

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most US-region tenants. Only change if your org uses another data center:
• EU region: https://www.zohoapis.eu
• India region: https://www.zohoapis.in
• Australia region: https://www.zohoapis.com.au
• China region: https://www.zohoapis.com.cn

If uncertain, contact your Zoho admin.

• LastName: Updated last name/family name (optional). Supports up to 255 characters. Example: 'Smith'
• Company: Updated company/organization name (optional). For B2B records, use employer name. Example: 'Acme Corporation'
• Email: Updated email address (optional). Format: user@example.com. Used for duplicate detection and communications.
• LeadSource: Updated lead source (optional). Common values: Advertisement, Cold Call, Employee Referral, External Referral, Online Store, Partner, Public Relations, Seminar, Trade Show, Web Download, Web Research, Chat. Your org may have custom sources.
• AdditionalFields: Additional lead fields as an object (optional). Use Zoho CRM field API names as keys. Common fields: First_Name (string), Phone (string), Mobile (string), Title (string), Industry (string), Lead_Status (string), Website (string), Description (string), Owner (object: {"id": "owner_id"}). Example: {"First_Name": "John", "Phone": "+1-555-123-4567", "Lead_Status": "Qualified"}

Output:

• UpdatedLead (object): Updated lead object containing: id (string: lead unique ID), Created_Time (string: ISO 8601), Modified_Time (string: ISO 8601), Full_Name (string), Email (string), Phone (string), Company (string), Lead_Status (string), Owner (object: with id and name)
• StatusCode (number): HTTP status code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), or HTTP error codes.
• ErrorMessage (string): Error message if failed, empty on success. Contains detailed error from Zoho API or validation.

Create a Contact

Creates a single contact in Zoho CRM

Input Parameters:

• LastName: The last name (family name) of the contact (required). This is the mandatory field for creating a contact in Zoho CRM. Example: Smith, Zhang.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• FirstName: The first name (given name) of the contact (optional). Example: John, Wei.
• Email: The primary email address of the contact (optional). Format: user@domain.com. Commonly used for duplicate checking. Example: john.smith@company.com
• Phone: The phone number of the contact (optional). Accepts any format. Example: +1-555-123-4567
• AdditionalFields: Additional contact fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Title": "CEO", "Department": "Executive"}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). If a matching record is found, Zoho returns an error instead of creating a duplicate. Leave empty to skip duplicate check. Example: Email or Email,Phone

Output:

• CreatedContact (object): The created contact object containing id, First_Name, Last_Name, Email, Phone, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create or Update a Contact

Creates or updates a contact in Zoho CRM

Input Parameters:

• LastName: The last name (family name) of the contact (required). This is the mandatory field for creating or updating a contact in Zoho CRM. Example: Smith, Zhang.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• FirstName: The first name (given name) of the contact (optional). Example: John, Wei.
• Email: The primary email address of the contact (optional). Format: user@domain.com. This field is used for duplicate checking when updating. Example: john.smith@company.com
• Phone: The phone number of the contact (optional). Accepts any format. Example: +1-555-123-4567
• ContactId: The ID of the contact to update (optional). If provided, updates this specific contact directly, bypassing duplicate check. You can obtain this ID from Search Contacts or Get Many Contacts action. Example: 3652397000000624001
• AdditionalFields: Additional contact fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Title": "CEO", "Department": "Executive"}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). If a matching record is found, Zoho updates it instead of creating a duplicate. Leave empty to use Email by default. Example: Email or Email,Phone

Output:

• CreatedOrUpdatedContact (object): The created or updated contact object containing id, First_Name, Last_Name, Email, Phone, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Delete a Contact

Deletes a contact from Zoho CRM

Input Parameters:

• ContactId: The ID of the contact to delete (required). You can obtain this ID from Search Contacts or Get Many Contacts action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).

Output:

• DeletedContact (object): The deleted contact object containing id (contact identifier) and status ("deleted").
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error or delete failed), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get Many Contacts

Retrieves many contacts from Zoho CRM

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• PerPage: Number of contacts per page (1-200). Default: 200
• Page: Page number for pagination (starts at 1). Default: 1
• AdditionalFields: Comma-separated field names to include in results beyond default fields. Use Zoho CRM field API names. Example: Title,Department,Mobile

Output:

• Contacts (object-array): Array of contact objects containing id, First_Name, Last_Name, Email, Phone, Owner, Created_Time, Modified_Time, and any fields specified in AdditionalFields.
• Info (object): Pagination metadata containing count (records in current page), more_records (boolean), per_page (records per page), page (current page number).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get a Contact

Retrieves a single contact from Zoho CRM

Input Parameters:

• ContactId: The ID of the contact to retrieve (required). You can obtain this ID from Search Contacts or Get Many Contacts action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• AdditionalFields: Comma-separated field names to include in result beyond default fields. Use Zoho CRM field API names. Example: Title,Department,Mobile

Output:

• Contact (object): The contact object containing id, First_Name, Last_Name, Email, Phone, Owner, Created_Time, Modified_Time, and any fields specified in AdditionalFields.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error or not found), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Search Contacts

Search contacts in Zoho CRM using criteria, email, phone, or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Criteria: Search criteria expression using format (Field:Operator:Value). Operators: equals, starts_with, contains, greater_than, less_than. Combine with 'and'/'or'. Example: (Last_Name:starts_with:Zhang)and(Lead_Source:equals:Web)
• Email: Search by email address (exact match). Example: john.smith@company.com
• Phone: Search by phone number (exact match). Example: +1-555-123-4567
• Keyword: Keyword search across multiple fields. Example: Zhang
• PerPage: Number of contacts per page (1-200). Default: 200
• Page: Page number for pagination (starts at 1). Default: 1
• AdditionalFields: Comma-separated field names to include in results. Use Zoho CRM field API names. Example: Title,Department,Mobile

Output:

• Contacts (object-array): List of contacts matching search criteria, containing id, First_Name, Last_Name, Email, Phone, Owner, Created_Time, Modified_Time, and any fields specified in AdditionalFields.
• Info (object): Pagination metadata containing count (records in current page), more_records (boolean), per_page (records per page), page (current page number).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Update a Contact

Updates a contact in Zoho CRM

Input Parameters:

• ContactId: The ID of the contact to update (required). You can obtain this ID from Search Contacts, Get Many Contacts, or Create Contact action response. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• LastName: The new last name of the contact (optional). Example: Smith
• FirstName: The new first name of the contact (optional). Example: John
• Email: The new email address of the contact (optional). Format: user@domain.com. Example: john.smith@company.com
• Phone: The new phone number of the contact (optional). Accepts any format. Example: +1-555-123-4567
• AdditionalFields: Additional contact fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Title": "CEO", "Department": "Executive"}

Output:

• UpdatedContact (object): The updated contact object containing id, First_Name, Last_Name, Email, Phone, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create an Account

Creates a single account in Zoho CRM

Input Parameters:

• AccountName: The company name (required). This is the primary identifier and is used for duplicate checking. Maximum 200 characters. Example: Acme Corporation

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Website: The company website URL (optional). Must be a valid URL starting with http:// or https://. Example: https://www.example.com
• Phone: The main phone number (optional). Accepts any format including international. Example: +1-555-123-4567
• BillingCity: The billing city (optional). Example: San Francisco
• AdditionalFields: Additional account fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Industry": "Technology", "Annual_Revenue": 1000000}
• DuplicateCheckFields: Comma-separated field names for duplicate checking (optional). If a matching record exists, creation will be skipped. Common fields: Account_Name, Website, Phone. Leave empty to use Account_Name by default. Example: Account_Name or Account_Name,Website

Output:

• CreatedAccount (object): The created account object containing id, Account_Name, Website, Phone, Billing_City, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create or Update an Account

Creates or updates an account in Zoho CRM

Input Parameters:

• AccountName: The company name (required). Used for duplicate checking by default. Example: Acme Corporation

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Website: The company website URL (optional). Example: https://www.example.com
• Phone: The main phone number (optional). Example: +1-555-123-4567
• BillingCity: The billing city (optional). Example: San Francisco
• AccountId: The ID of the account to update (optional). If provided, updates this specific account directly, bypassing duplicate check. You can obtain this ID from Search Accounts or Get Many Accounts action. Example: 3652397000000624001
• AdditionalFields: Additional account fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Industry": "Technology", "Annual_Revenue": 1000000}
• DuplicateCheckFields: Comma-separated field names for duplicate checking (optional). If a matching record exists, Zoho updates it instead of creating a duplicate. Leave empty to use Account_Name by default. Example: Account_Name or Account_Name,Website

Output:

• CreatedOrUpdatedAccount (object): The created or updated account object containing id, Account_Name, Website, Phone, Billing_City, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Delete an Account

Deletes an account from Zoho CRM

Input Parameters:

• AccountId: The ID of the account to delete (required). You can obtain this ID from Search Accounts or Get Many Accounts action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).

Output:

• DeletedAccount (object): The deleted account object containing id (account identifier) and status ("deleted").
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error or delete failed), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get Many Accounts

Retrieves many accounts from Zoho CRM

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• PerPage: Number of accounts per page (1-200). Default: 200
• Page: Page number for pagination (starts at 1). Default: 1
• AdditionalFields: Comma-separated field names to include in results beyond default fields. Use Zoho CRM field API names. Example: Industry,Annual_Revenue,Employees

Output:

• Accounts (object-array): Array of account objects containing id, Account_Name, Phone, Website, Owner, Created_Time, Modified_Time, and any fields specified in AdditionalFields.
• Info (object): Pagination metadata containing count (records in current page), more_records (boolean), per_page (records per page), page (current page number).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get an Account

Retrieves a single account from Zoho CRM

Input Parameters:

• AccountId: The ID of the account to retrieve (required). You can obtain this ID from Search Accounts or Get Many Accounts action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• AdditionalFields: Comma-separated field names to include in result beyond default fields. Use Zoho CRM field API names. Example: Industry,Annual_Revenue,Employees

Output:

• Account (object): The account object containing id, Account_Name, Phone, Website, Owner, Created_Time, Modified_Time, and any fields specified in AdditionalFields.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error or not found), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Search Accounts

Search accounts in Zoho CRM using criteria, email, phone, or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Criteria: Search criteria expression using format (Field:Operator:Value). Operators: equals, starts_with, contains, greater_than, less_than. Combine with 'and'/'or'. Example: (Account_Name:starts_with:ABC)and(Industry:equals:Technology)
• Email: Search by email address (exact match). Example: info@example.com
• Phone: Search by phone number (exact match). Example: +1-555-123-4567
• Keyword: Keyword search across multiple fields. Example: Technology
• PerPage: Number of accounts per page (1-200). Default: 200
• Page: Page number for pagination (starts at 1). Default: 1
• AdditionalFields: Comma-separated field names to include in results. Use Zoho CRM field API names. Example: Industry,Annual_Revenue,Employees

Output:

• Accounts (object-array): List of accounts matching search criteria, containing id, Account_Name, Phone, Website, Owner, Created_Time, Modified_Time, and any fields specified in AdditionalFields.
• Info (object): Pagination metadata containing count (records in current page), more_records (boolean), per_page (records per page), page (current page number).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Update an Account

Updates an account in Zoho CRM

Input Parameters:

• AccountId: The ID of the account to update (required). You can obtain this ID from Search Accounts or Get Many Accounts action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• AccountName: The new account name (optional). Example: Acme Corporation
• Website: The new website URL (optional). Must include http:// or https://. Example: https://www.example.com
• Phone: The new phone number (optional). Supports international format. Example: +1-555-123-4567
• BillingCity: The new billing city (optional). Example: San Francisco
• AdditionalFields: Additional account fields as an object (optional). Use Zoho CRM field API names as keys. Example: {"Industry": "Technology", "Annual_Revenue": 1000000}

Output:

• UpdatedAccount (object): The updated account object containing id, Account_Name, Website, Phone, Billing_City, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create a Deal

Creates a single deal in Zoho CRM

Input Parameters:

• DealName: The name of the deal (required). Use a descriptive name identifying the opportunity and customer. Example: Acme Corp - Enterprise License
• Amount: The monetary value of the deal (required) in your account's default currency. Example: 50000
• Stage: The sales pipeline stage (required). Select the stage reflecting where this deal is in your sales process.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• AccountId: The ID of the associated account (optional). Links this deal to a company/organization. You can obtain this ID from Get Many Accounts or Search Accounts action. Example: 3652397000000624001
• ClosingDate: The expected closing date (optional). Format: YYYY-MM-DD. Example: 2024-12-31
• AdditionalFields: Additional deal fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Probability": 75, "Next_Step": "Schedule demo"}
• DuplicateCheckFields: Comma-separated field names for duplicate checking (optional). If a matching deal exists, creation will be skipped. Common fields: Deal_Name, Amount. Leave empty to skip checking. Example: Deal_Name or Deal_Name,Amount

Output:

• CreatedDeal (object): The created deal object containing id, Deal_Name, Amount, Stage, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create or Update a Deal

Creates or updates a deal in Zoho CRM

Input Parameters:

• DealName: The name of the deal (required). Use a descriptive name identifying the opportunity and customer. Example: Acme Corp - Enterprise License
• Amount: The monetary value of the deal (required) in your account's default currency. Example: 50000
• Stage: The sales pipeline stage (required). Select the stage reflecting where this deal is in your sales process.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• AccountId: The ID of the associated account (optional). Links this deal to a company/organization. You can obtain this ID from Get Many Accounts or Search Accounts action. Example: 3652397000000624001
• ClosingDate: The expected closing date (optional). Format: YYYY-MM-DD. Example: 2024-12-31
• DealId: The ID of the deal to update (optional). If provided, update this specific deal directly, bypassing duplicate check. You can obtain this ID from Search Deals or Get Many Deals action. Example: 3652397000000624001
• AdditionalFields: Additional deal fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Probability": 75, "Next_Step": "Schedule demo"}
• DuplicateCheckFields: Comma-separated field names for duplicate checking (optional). If a matching deal exists, will update instead of creating. Common fields: Deal_Name, Amount. Leave empty to skip checking. Example: Deal_Name or Deal_Name,Amount

Output:

• CreatedOrUpdatedDeal (object): The created or updated deal object containing id, Deal_Name, Amount, Stage, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Delete a Deal

Deletes a deal from Zoho CRM

Input Parameters:

• DealId: The ID of the deal to delete (required). You can obtain this ID from Search Deals or Get Many Deals action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).

Output:

• DeletedDeal (object): Deletion result object containing id (deleted deal's ID) and status (fixed value: deleted).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get Many Deals

Retrieves many deals from Zoho CRM

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• PerPage: Number of records per page (1-200). Default: 200
• Page: Page number for pagination (starts at 1). Default: 1
• AdditionalFields: Comma-separated field names to include beyond default fields. Use Zoho CRM field API names. Example: Custom_Field_1,Department

Output:

• Deals (object-array): Array of deal objects containing id, Deal_Name, Amount, Stage, Probability, Closing_Date, Account_Name, Owner, Created_Time, Modified_Time, and any AdditionalFields requested.
• Info (object): Pagination metadata containing count (records in this page), more_records (boolean), page (current page), per_page (records per page).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get a Deal

Retrieves a single deal from Zoho CRM

Input Parameters:

• DealId: The ID of the deal to retrieve (required). You can obtain this ID from Search Deals or Get Many Deals action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• AdditionalFields: Comma-separated field names to include beyond default fields. Use Zoho CRM field API names. Example: Custom_Field_1,Department

Output:

• Deal (object): The deal object containing id, Deal_Name, Amount, Stage, Probability, Closing_Date, Account_Name, Contact_Name, Owner, Created_Time, Modified_Time, and any AdditionalFields requested.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Search Deals

Search deals in Zoho CRM using criteria or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Criteria: Search condition using Zoho query syntax (optional). Format: (Field:Operator:Value). Operators: equals, contains, starts_with, ends_with, greater_than, less_than. Multiple conditions with AND/OR. Example: (Deal_Name:contains:Project)and(Stage:equals:Closed Won)
• Keyword: Keyword search across multiple fields (optional). Used if Criteria is empty. Example: My Deal
• PerPage: Records per page (1-200). Default: 200
• Page: Page number (starts at 1). Default: 1
• AdditionalFields: Comma-separated field names to include beyond default fields. Use Zoho CRM field API names. Example: Custom_Field_1,Probability

Output:

• Deals (object-array): Array of deal objects matching search criteria. Each contains id, Deal_Name, Amount, Stage, Probability, Closing_Date, Account_Name, Owner, Created_Time, Modified_Time, and any AdditionalFields requested.
• Info (object): Pagination metadata containing count (records in this page), more_records (boolean), page (current page), per_page (records per page).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Update a Deal

Updates a deal in Zoho CRM

Input Parameters:

• DealId: The ID of the deal to update (required). You can obtain this ID from Search Deals or Get Many Deals action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• DealName: The new name of the deal (optional). Example: Updated Deal Name
• Amount: The new amount of the deal (optional). Example: 75000
• Stage: The new stage of the deal (optional). Stages: Qualification, Needs Analysis, Value Proposition, Id. Decision Makers, Proposal/Price Quote, Negotiation/Review, Closed Won, Closed Lost.
• AccountId: The new associated account ID (optional). You can obtain this ID from Search Accounts or Get Many Accounts action. Example: 3652397000000624001
• AdditionalFields: Additional deal fields as an object (optional). Use Zoho CRM field API names as keys. Example: {"Probability": 75, "Next_Step": "Send contract"}

Output:

• UpdatedDeal (object): The updated deal object containing id, Deal_Name, Amount, Stage, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create a Product

Creates a single product in Zoho CRM

Input Parameters:

• ProductName: The name of the product (required). Example: Enterprise Software License.
• UnitPrice: The unit price of the product in your account default currency (optional). Example: 99.99
• ProductActive: Whether the product is active and available for sale (optional). true = active, false = inactive.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• ProductCode: The product code or SKU for inventory tracking (optional). Example: SKU-12345.
• Description: Detailed description of the product (optional).
• Manufacturer: The manufacturer or brand name of the product (optional). Example: Apple, Samsung.
• AdditionalFields: Additional product fields as JSON object (optional). Use Zoho CRM field API names as keys. Note: Different fields have different data types in Zoho CRM. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {\"Qty_in_Stock\": 100, \"Manufacturer\": \"Tech Corp\"}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). If left empty, uses default duplicate checking.

Example: 'Product_Code' or 'Product_Code,Manufacturer'

Output:

• CreatedProduct (object): The created product object containing id, Product_Name, Product_Code, Unit_Price, Created_Time, Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create or Update a Product

Creates a new product or updates an existing product in Zoho CRM using upsert

Input Parameters:

• ProductName: The name of the product (required). Example: Enterprise Software License.
• UnitPrice: The unit price of the product in your account default currency (optional). Example: 99.99
• ProductActive: Whether the product is active and available for sale (optional). true = active, false = inactive.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• ProductCode: The product code or SKU for inventory tracking (optional). Example: SKU-12345.
• Description: Detailed description of the product (optional).
• Manufacturer: The manufacturer or brand name of the product (optional). Example: Apple, Samsung.
• ProductId: The ID of an existing product to update (optional). If provided, updates the existing product directly. How to get this ID: Use 'Search Products' or 'Get Many Products' action.
• AdditionalFields: Additional product fields as JSON object (optional). Use Zoho CRM field API names as keys. Note: Different fields have different data types in Zoho CRM. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Qty_in_Stock": 100, "Manufacturer": "Tech Corp"}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). If left empty, uses default duplicate checking. Example: 'Product_Code' or 'Product_Code,Manufacturer'

Output:

• CreatedOrUpdatedProduct (object): The created or updated product object containing id, Product_Name, Product_Code, Unit_Price, Created_Time, Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Delete a Product

Deletes a single product from Zoho CRM

Input Parameters:

• ProductId: The unique ID of the product to delete (required). You can obtain this ID through: Search Products or Get Many Products action, or from the response of Create Product action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.

Output:

• DeletedProduct (object): The deleted product object containing: id (deleted product ID) and status (always 'deleted' on success).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error or status message. Empty when successful. When rate limited (429), includes retry wait time.

Get Many Products

Retrieves a paginated list of products from Zoho CRM

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number for pagination. Starts from 1. Default: 1.
• AdditionalFields: Comma-separated field names to include in results. Only use for custom fields not in default set. Example: Custom_Field_1,Custom_Field_2

Output:

• Products (object-array): Array of product objects with fields: Id, Product_Name, Product_Code, Product_Active, Manufacturer, Unit_Price, Qty_in_Stock, Tax, Owner, Created_Time, Modified_Time, and additional fields if specified.
• Info (object): Pagination metadata: per_page (records per page), page (current page), count (records in response), more_records (whether more pages available).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error or status message. Empty when successful. When rate limited (429), includes retry wait time.

Get a Product

Retrieves a single product from Zoho CRM by its ID

Input Parameters:

• ProductId: The unique ID of the product to retrieve (required). You can obtain this ID through: Search Products or Get Many Products action, or from the response of Create Product action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.
• Fields: Comma-separated field names to include in results. Leave empty to retrieve all fields. Example: Product_Name,Unit_Price,Qty_in_Stock

Output:

• Product (object): The product object containing: id, Product_Name, Product_Code, Product_Active, Manufacturer, Unit_Price, Qty_in_Stock, Tax, Owner, Created_Time, Modified_Time, and additional fields if specified.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error or status message. Empty when successful. When rate limited (429), includes retry wait time.

Search Products

Search products in Zoho CRM using criteria or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.
• Criteria: Advanced search criteria in format (Field:Operator:Value). Operators: equals, starts_with, contains, greater_than, less_than. Examples: (Product_Name:starts_with:iPhone), (Product_Active:equals:true)and(Unit_Price:greater_than:100). Priority: Criteria > Keyword.
• Keyword: Keyword search across multiple fields. Lower priority than Criteria. Example: Enterprise
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number for pagination. Starts from 1. Default: 1.
• AdditionalFields: Comma-separated field names to include in results. Only use for custom fields not in default set. Example: Custom_Field_1,Custom_Field_2

Output:

• Products (object-array): Array of product objects matching search criteria. Each contains: Id, Product_Name, Product_Code, Product_Active, Manufacturer, Unit_Price, Qty_in_Stock, Tax, Owner, Created_Time, Modified_Time, and additional fields if specified.
• Info (object): Pagination metadata: count (records in response), more_records (whether more available), per_page (records per page), page (current page number).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error or status message. Empty when successful. When rate limited (429), includes retry wait time.

Update a Product

Updates an existing product in Zoho CRM

Input Parameters:

• ProductId: The ID of the product to update (required). You can obtain this ID from Search Products or Get Many Products action. Example: 5725767000000323001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• ProductName: The new name of the product (optional). Example: Enterprise Software License v2.0
• ProductCode: The new product code or SKU (optional). Example: SKU-12345-v2
• UnitPrice: The new unit price (optional). Must be positive. Example: 99.99
• Description: The new description of the product (optional). Example: High-quality enterprise software
• Manufacturer: The new manufacturer or brand name (optional). Example: Tech Corp
• AdditionalFields: Additional product fields as an object (optional). Use Zoho CRM field API names as keys. Example: {"Qty_in_Stock": 100}

Output:

• UpdatedProduct (object): The updated product object containing id, Product_Name, Product_Code, Unit_Price, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create a Quote

Creates a single quote in Zoho CRM with product details, addresses, and related records

Input Parameters:

• Subject: The subject/title of the quote (required). Example: Quote for Enterprise License 2024.
• ProductId: The unique ID of the product for the quote line item (required). Get this ID via Get Many Products or Search Products action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• QuoteStage: The current stage of the quote in the sales cycle (optional).
• ValidTill: Quote expiration date in YYYY-MM-DD format (optional). Example: 2024-12-31
• AccountId: The unique ID of the associated company/account (optional). Get this ID via Get Many Accounts or Search Accounts action.
• ContactId: The unique ID of the contact person (optional). Get this ID via Get Many Contacts or Search Contacts action.
• Quantity: The quantity of products to quote (optional, default 1). Must be a positive integer.
• ListPrice: The unit price per product in your account default currency (optional). If 0 or not set, uses the product's default price.
• Description: Additional notes or terms for this quote (optional).
• AdditionalFields: Additional quote fields as an object (optional). Use Zoho CRM field API names as keys. Example: {"Deal_Name": {"id": "xxx"}, "Carrier": "FedEx"}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). Example: Subject

Output:

• CreatedQuote (object): The created quote object containing id, Subject, Quote_Stage, Valid_Till, Grand_Total, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 503/504 (network error), or other HTTP status codes.
• ErrorMessage (string): Detailed error description. Empty string when successful.

Create or Update a Quote

Creates or updates a quote in Zoho CRM using upsert with product details, addresses, and related records

Input Parameters:

• Subject: The subject/title of the quote (required). NOTE: Subject is used for duplicate checking (upsert). If a Quote with the same Subject exists, it will be updated.
• ProductId: The ID of the product for line item (required). IMPORTANT: This action only supports ONE product per quote. For multiple products, use AdditionalFields. How to get: Use 'Search Products' action.

Options:

• ZohoUrl: The base URL of the Zoho CRM instance. Usually no modification needed, use default value. For EU/CN regions, contact your admin.
• QuoteStage: The stage of the quote (optional).
• ValidTill: The quote validity/expiration date (optional). Format: YYYY-MM-DD. Example: 2024-12-31
• AccountId: The associated account/company ID (optional). For B2B quotes, link to the company. How to get: Use 'Search Accounts' action.
• ContactId: The associated contact/person ID (optional). For B2C quotes, link to the individual. How to get: Use 'Search Contacts' action.
• Quantity: The quantity of the product (optional, default 1). Must be a positive integer.
• ListPrice: The unit price per product (optional). If not provided, uses the product's default price. Example: 99.99
• Description: The description (optional).
• QuoteId: The ID of existing quote to update (optional). If provided, updates directly. How to get: Use 'Search Quotes' or 'Get Many Quotes' action.
• AdditionalFields: Additional fields as an object (optional). Common fields: Terms_and_Conditions (string: terms text), Discount (number: discount amount), Tax (number: tax amount), Adjustment (number: adjustment amount). For multiple line items, override Quoted_Items array. Example: {"Terms_and_Conditions": "Net 30", "Discount": 100}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). If a matching record is found, Zoho updates it instead of creating a duplicate. Leave empty to use Subject by default. Example: Subject or Subject,Account_Name

Output:

• CreatedOrUpdatedQuote (object): Details of the created or updated quote. Contains: id (string, Quote unique ID), Created_Time (string, ISO 8601), Modified_Time (string, ISO 8601), action (string, 'insert' or 'update').
• StatusCode (number): The HTTP status code.
• ErrorMessage (string): Any error message.

Delete a Quote

Deletes a single quote from Zoho CRM

Input Parameters:

• QuoteId: 要删除的 Quote 的唯一 ID。可通过 Search Quotes 或 Get Many Quotes 接口获取。格式为 Zoho 系统生成的数字字符串，如 "4150868000001234567"。

Options:

• ZohoUrl: Zoho CRM 服务器地址。通常无需修改，使用默认值即可。如果您使用的是欧洲区 (zohoapis.eu)、中国区 (zohoapis.com.cn) 或澳洲区 (zohoapis.com.au) 的 Zoho，请联系管理员获取正确地址。

Output:

• DeletedQuote (object): 删除结果对象，包含字段：
• id (string): 被删除 Quote 的唯一 ID
• status (string): 固定值 "deleted"
• StatusCode (number): The HTTP status code.
• ErrorMessage (string): Any error message.

Get Many Quotes

Retrieves a paginated list of quotes from Zoho CRM

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number for pagination. Starts from 1. Default: 1.
• AdditionalFields: Comma-separated list of additional field API names to include in results (optional). Leave empty to retrieve default fields. Example: Custom_Field_1,Custom_Field_2

Output:

• Quotes (object-array): Array of quote objects. Each contains id, Subject, Quote_Stage, Valid_Till, Grand_Total, Sub_Total, Tax, Discount, Account_Name, Contact_Name, Deal_Name, Owner, Created_Time, Modified_Time, and any additional fields requested.
• Info (object): Pagination metadata object with per_page (records per page), page (current page), count (records in current response), more_records (boolean indicating if more pages exist).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 404 (no results), 429 (rate limited), 503/504 (network error), or other HTTP status codes.
• ErrorMessage (string): Detailed error description. Empty string when successful.

Get a Quote

Retrieves a single quote from Zoho CRM by its ID

Input Parameters:

• QuoteId: The unique ID of the quote to retrieve (required). Get this ID via Search Quotes or Get Many Quotes actions.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Fields: Comma-separated list of field API names to retrieve (optional). Leave empty to retrieve all default fields. Example: Subject,Total,Valid_Till

Output:

• Quote (object): The quote object containing id, Subject, Total, Valid_Till, Quote_Stage, Account_Name, Contact_Name, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 404 (quote not found), 429 (rate limited), 503/504 (network error), or other HTTP status codes.
• ErrorMessage (string): Detailed error description. Empty string when successful.

Search Quotes

Search quotes in Zoho CRM using criteria or keyword

Options:

• ZohoUrl: The base URL of the Zoho CRM instance. Default is https://www.zohoapis.com for US datacenter. If you are using EU/CN/IN datacenter, please use the corresponding URL (e.g., https://www.zohoapis.eu for EU). Most users can keep the default value. This field is optional and defaults to the US datacenter URL if left empty.
• Criteria: Search criteria expression. Format: (Field:Operator:Value).

Supported Operators:

• equals: Exact match
• starts_with: Prefix match
• contains: Contains (supported by some fields)
• greater_than/less_than: Numeric/date comparison

Multiple Conditions:

• AND: (Field1:equals:A)and(Field2:equals:B)
• OR: (Field1:equals:A)or(Field2:equals:B)

Examples:

• Single: (Subject:starts_with:Q-)
• Multiple: (Quote_Stage:equals:Delivered)and(Grand_Total:greater_than:10000)

Priority: If multiple search parameters are provided (Criteria/Keyword), only the highest priority one takes effect: Criteria > Keyword.

• Keyword: Keyword search (searches across multiple fields).
• PerPage: Number of records per page (max 200). Default is 200 if not specified.
• Page: Page number to retrieve. Default is 1 if not specified.
• AdditionalFields: Comma-separated list of additional fields to retrieve. Example: 'Custom_Field_1,Custom_Field_2,Owner_Name'

Output:

• Quotes (object-array): List of quotes matching the search criteria. Each quote object contains fields like: Id (string), Subject (string), Quote_Stage (string), Valid_Till (string), Grand_Total (number), Sub_Total (number), Tax (number), Account_Name (string), Contact_Name (string), Deal_Name (string), Owner (object), Created_Time (string), Modified_Time (string), and other fields specified in AdditionalFields parameter.
• Info (object): Pagination metadata object containing: count (number) - number of records in current response, more_records (boolean) - whether there are more records available, per_page (number) - records per page, page (number) - current page number.
• StatusCode (number): HTTP status code.
• ErrorMessage (string): Error message.

Update a Quote

Updates an existing quote in Zoho CRM with product details, addresses, and related records

Input Parameters:

• QuoteId: The unique ID of the quote to update (required). You can obtain this ID through: Search Quotes or Get Many Quotes action, or from the response of Create Quote action.

Options:

• ZohoUrl: Zoho CRM API base URL (usually no need to modify, use default value). If you are using Zoho in Europe or China region, please contact your administrator for the correct URL.
• Subject: [EN] The new subject/title of the quote (optional). Supports up to 255 characters. This is the main identifier shown in quote lists.

[CN] 新的报价主题/标题（可选）。支持最多 255 个字符。这是报价列表中显示的主要标识。

Example / 示例: Q2 2026 Enterprise License Proposal

• QuoteStage: The new stage of the quote (optional). Quote lifecycle stages:
• Draft: Initial quote draft, not yet sent to customer
• Negotiation: Under negotiation with customer
• Delivered: Quote has been sent/delivered to customer
• On Hold: Temporarily paused, waiting for customer decision
• Confirmed: Customer accepted the quote
• Closed Won: Quote converted to order/deal
• Closed Lost: Customer rejected or quote expired
• ValidTill: The new validity/expiration date of the quote in YYYY-MM-DD format (optional). Example: 2026-12-31
• AccountId: The new associated account (company) ID (optional). You can obtain this ID through: Search Accounts or Get Many Accounts action.
• ContactId: The new associated contact person ID (optional). You can obtain this ID through: Search Contacts or Get Many Contacts action. This is the main contact for this quote.
• ProductId: [EN] The product ID for line item (optional). You can obtain this ID through: Search Products or Get Many Products action. Used together with Quantity and ListPrice to update quote items.

[CN] 产品行项目的 ID（可选）。可通过 Search Products 或 Get Many Products 操作获取。需与 Quantity 和 ListPrice 配合使用。

⚠️ NOTE / 注意: Currently only supports updating a single product line item. For multiple products, call this action multiple times or use the AdditionalFields parameter with Quoted_Items array.

当前仅支持更新单个产品行项目。如需多个产品，请多次调用或使用 AdditionalFields 参数传递 Quoted_Items 数组。

Example / 示例: 3652397000000856001

• Quantity: The quantity of the product (optional, default 1).
• ListPrice: The unit price of the product (optional).
• Description: [EN] The new internal description/notes for the quote (optional). Supports up to 32,000 characters. Use this field to record important details, special terms, or internal notes.

[CN] 新的内部描述/备注（可选）。支持最多 32,000 个字符。用于记录重要细节、特殊条款或内部备注。

Example / 示例: Customer requested 10% discount for annual commitment. Include implementation services.

• AdditionalFields: ⚠️ [EN] Advanced option: Additional quote fields as an object. Only use when you need to update non-standard or custom fields. Keys must be valid Zoho CRM field API names.

[CN] ⚠️ 高级选项：额外的报价字段（对象格式）。仅在需要更新非标准或自定义字段时使用。Key 必须是有效的 Zoho CRM 字段 API 名称。

Common fields / 常见字段:

• Discount (number): Discount amount / 折扣金额
• Tax (number): Tax amount / 税金
• Terms_and_Conditions (string): Payment terms / 付款条款
• Adjustment (number): Adjustment amount / 调整金额

Example / 示例: {"Discount": 10, "Tax": 50, "Terms_and_Conditions": "Net 30 days"}

Output:

• UpdatedQuote (object): The updated Quote object containing the following core fields:
• id (string): Quote unique identifier
• Created_Time (string): Creation time in ISO 8601 format
• Modified_Time (string): Last modification time
• Subject (string): Quote subject/title
• Quote_Stage (string): Current stage (Draft/Negotiation/Delivered/Confirmed/Closed Won/Closed Lost)
• Valid_Till (string): Quote validity date
• Grand_Total (number): Total amount
• Owner (object): Owner information with id and name
• StatusCode (number): The HTTP status code.
• ErrorMessage (string): Any error message.

Create a Sales Order

Creates a single sales order in Zoho CRM with product details, addresses, and related records

Input Parameters:

• Subject: The subject/title of the sales order (required). Example: 'SO-2024-001 Enterprise License'.
• ProductId: The unique ID of the product to sell (required). You can obtain this ID through: Search Products or Get Many Products action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Status: The current status of the sales order (optional). Supported values: Created, Approved, Delivered, Cancelled.
• AccountId: The unique ID of the customer company/account (optional). You can obtain this ID through: Search Accounts or Get Many Accounts action.
• ContactId: The unique ID of the contact person at the customer (optional). You can obtain this ID through: Search Contacts or Get Many Contacts action.
• DueDate: Expected delivery date in YYYY-MM-DD format (optional). Example: '2024-12-31'.
• Quantity: The quantity of products to sell (optional, default 1). Must be a positive number. Example: 5.
• ListPrice: The unit price per product in your account default currency (optional). If 0 or not set, uses the product's default price. Example: 99.99.
• Description: Additional notes or terms for this sales order (optional). Example: 'Urgent delivery requested'.
• AdditionalFields: Additional sales order fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Deal_Name": {"id": "xxx"}, "Carrier": "FedEx"}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). If a matching record is found, Zoho returns an error instead of creating a duplicate. Leave empty to skip duplicate check. Example: Subject

Output:

• CreatedSalesOrder (object): The created sales order object containing id, Subject, Status, Grand_Total, Due_Date, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create or Update a Sales Order

Creates or updates a sales order in Zoho CRM using upsert

Input Parameters:

• Subject: The subject/title of the sales order (required). Used for duplicate checking - if a sales order with this subject exists, it will be updated instead of creating a new one. Example: 'SO-2024-001 Enterprise'.
• ProductId: The unique ID of the product to sell (required). This action supports one product per order. You can obtain this ID through: Search Products or Get Many Products action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Status: The current status of the sales order (optional). Supported values: Created, Approved, Delivered, Cancelled.
• AccountId: The unique ID of the customer company/account (optional). You can obtain this ID through: Search Accounts or Get Many Accounts action.
• ContactId: The unique ID of the contact person at the customer (optional). You can obtain this ID through: Search Contacts or Get Many Contacts action.
• DueDate: Expected delivery date in YYYY-MM-DD format (optional). Example: '2024-12-31'.
• Quantity: The quantity of products to sell (optional, default 1). Must be a positive number. Example: 5.
• ListPrice: The unit price per product in your account default currency (optional). If 0 or not set, uses the product's default price. Example: 99.99.
• Description: Additional notes or terms for this sales order (optional). Example: 'Standard delivery terms apply'.
• SalesOrderId: The ID of an existing sales order to update (optional). If provided, updates the existing sales order directly. You can obtain this ID through: Search Sales Orders or Get Many Sales Orders action.
• AdditionalFields: Additional sales order fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Carrier": "UPS", "Discount": 100}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). When creating or updating, if a matching record is found by these fields, it will be updated instead of creating a new one. Leave empty to use default (Subject). Example: Subject or Subject,AccountId

Output:

• CreatedOrUpdatedSalesOrder (object): The created or updated sales order object containing id, Subject, Status, Grand_Total, Due_Date, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Delete a Sales Order

Deletes a single sales order from Zoho CRM by ID

Input Parameters:

• SalesOrderId: The unique ID of the sales order to delete (required). You can obtain this ID through: Search Sales Orders or Get Many Sales Orders action, or from the response of Create Sales Order action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.

Output:

• DeletedSalesOrder (object): The deleted sales order object containing id (deleted sales order ID) and status (always 'deleted' on success).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get Many Sales Orders

Retrieves a list of sales orders from Zoho CRM with pagination

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.
• PerPage: Number of sales orders to retrieve per page (optional, default 200). Valid range: 1-200. Example: 50.
• Page: Page number to retrieve (optional, default 1, 1-based). Use with PerPage for pagination. Check Info.more_records in response to determine if more pages exist. Example: 1.
• AdditionalFields: Comma-separated field names to include in response (optional). Leave empty to use default fields. Use '*' to retrieve all available fields (may impact performance). Example: 'Excise_Duty,Sales_Commission'.

Output:

• SalesOrders (object-array): Array of sales order objects. Each object contains: id, Subject, Status, Grand_Total, Due_Date, Account_Name, Contact_Name, Ordered_Items, and other fields as requested.
• Info (object): Pagination metadata object containing: per_page (records per page), page (current page number), count (records in current page), more_records (boolean - true if additional pages exist).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time. 'No sales orders found' indicates empty result set.

Get a Sales Order

Retrieves a single sales order from Zoho CRM by ID

Input Parameters:

• SalesOrderId: The unique ID of the sales order to retrieve (required). You can obtain this ID through: Search Sales Orders or Get Many Sales Orders action, or from the response of Create Sales Order action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.

Output:

• SalesOrder (object): The sales order object retrieved from Zoho CRM containing all sales order details including id, Subject, Status, Grand_Total, Due_Date, Account_Name, Contact_Name, Ordered_Items, and other fields.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Search Sales Orders

Search sales orders in Zoho CRM using criteria or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.
• Criteria: Search criteria expression using Zoho CRM format (optional). Format: (Field:Operator:Value). Operators: equals, starts_with, contains, greater_than, less_than. Multiple conditions use 'and'/'or'. Example: '(Subject:starts_with:SO-)and(Status:equals:Created)'.
• Keyword: Keyword search across multiple fields (optional). Searches for the keyword in standard fields. Note: Criteria takes precedence over Keyword if both are provided. Example: 'Enterprise Customer'.
• PerPage: Number of records to retrieve per page (optional, default 200). Valid range: 1-200. Example: 50.
• Page: Page number to retrieve (optional, default 1, 1-based). Use with PerPage for pagination. Check Info.more_records in response to determine if more pages exist. Example: 1.
• AdditionalFields: Comma-separated field names to include in response (optional). Leave empty to use default fields. Use '*' to retrieve all available fields (may impact performance). Example: 'Excise_Duty,Sales_Commission'.

Output:

• SalesOrders (object-array): Array of sales order objects matching the search criteria. Each object contains: id, Subject, Status, Grand_Total, Due_Date, Account_Name, Contact_Name, Ordered_Items, and other fields as requested.
• Info (object): Pagination metadata object containing: per_page (records per page), page (current page number), count (records in current page), more_records (boolean - true if additional pages exist).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time. 'No sales orders found matching search criteria' indicates empty result set.

Update a Sales Order

Updates an existing sales order in Zoho CRM

Input Parameters:

• SalesOrderId: The unique ID of the sales order to update (required). You can obtain this ID through: Search Sales Orders or Get Many Sales Orders action, or from the response of Create Sales Order action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.
• Subject: The subject/title of the sales order (optional). Example: 'SO-2024-001 Enterprise'.
• Status: The status of the sales order (optional). Supported values: Created, Approved, Delivered, Cancelled.
• AccountId: The unique ID of the customer company/account (optional). You can obtain this ID through: Search Accounts or Get Many Accounts action.
• ContactId: The unique ID of the contact person at the customer (optional). You can obtain this ID through: Search Contacts or Get Many Contacts action.
• DueDate: Expected delivery date in YYYY-MM-DD format (optional). Example: '2024-12-31'.
• ProductId: The unique ID of the product to update in line items (optional). This action supports one product per request. You can obtain this ID through: Search Products or Get Many Products action.
• Quantity: The quantity of products (optional, default 1). Must be a positive number. Example: 5.
• ListPrice: The unit price per product in your account default currency (optional). If 0 or not set, uses the product's default price. Example: 99.99.
• Description: Additional notes or terms for this sales order (optional). Example: 'Standard delivery terms apply'.
• AdditionalFields: Additional sales order fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Carrier": "UPS", "Discount": 100}

Output:

• UpdatedSalesOrder (object): The updated sales order object containing id, Subject, Status, Grand_Total, Due_Date, Created_Time, Modified_Time, Owner, and other fields.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time. 'At least one field must be provided' when no update fields are specified.

Create a Purchase Order

Creates a single purchase order in Zoho CRM with product details, addresses, and vendor

Input Parameters:

• Subject: The subject/title of the purchase order (required). Example: PO-2024-001 Office Supplies
• ProductId: The ID of the product to order (required). You can obtain this ID from Get Many Products or Search Products action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Status: The status of the purchase order (optional). Statuses: Created, Approved, Delivered, Cancelled, Rejected, Received
• VendorId: The ID of the vendor/supplier (optional). You can obtain this ID from Get Many Vendors or Search Vendors action. Example: 3652397000000624001
• ContactId: The ID of the contact person at the vendor (optional). You can obtain this ID from Get Many Contacts action. Example: 3652397000000624001
• DueDate: Expected delivery date (optional). Format: YYYY-MM-DD. Example: 2024-12-31
• Quantity: The quantity of products to order (optional, default 1). Must be a positive number. Example: 10
• ListPrice: The unit price per product in your account's currency (optional, default 0). If 0, uses product's default price. Example: 99.99
• Description: Additional notes or description for this purchase order (optional). Example: Rush order for client A
• AdditionalFields: Additional PO fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Tracking_Number": "TRK123", "Carrier": "FedEx"}
• DuplicateCheckFields: Comma-separated field names for duplicate checking (optional). If a matching PO exists, creation will be skipped. Leave empty to skip checking. Example: Subject

Output:

• CreatedPurchaseOrder (object): The created purchase order object containing id, Subject, Status, Vendor_Name, Grand_Total, Created_Time, Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create or Update a Purchase Order

Creates or updates a purchase order in Zoho CRM using upsert

Input Parameters:

• Subject: The subject/title of the purchase order (required). Example: PO-2024-001 Office Supplies
• ProductId: The ID of the product to order (required). You can obtain this ID from Get Many Products or Search Products action. Example: 3652397000000624001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Status: The status of the purchase order (optional). Statuses: Created, Approved, Delivered, Cancelled, Rejected, Received
• VendorId: The ID of the vendor/supplier (optional). You can obtain this ID from Get Many Vendors or Search Vendors action. Example: 3652397000000624001
• ContactId: The ID of the contact person at the vendor (optional). You can obtain this ID from Get Many Contacts action. Example: 3652397000000624001
• DueDate: Expected delivery date (optional). Format: YYYY-MM-DD. Example: 2024-12-31
• Quantity: The quantity of products to order (optional, default 1). Must be a positive number. Example: 10
• ListPrice: The unit price per product in your account's currency (optional, default 0). If 0, uses product's default price. Example: 99.99
• Description: Additional notes or description for this purchase order (optional). Example: Rush order for client A
• PurchaseOrderId: The ID of an existing PO to update (optional). If provided, directly updates that PO. You can obtain this ID from Search Purchase Orders or Get Many Purchase Orders action. Example: 3652397000000624001
• AdditionalFields: Additional PO fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Tracking_Number": "TRK123", "Carrier": "FedEx"}
• DuplicateCheckFields: Comma-separated field names for duplicate checking (optional). If a matching PO exists, will update instead of creating. Leave empty to skip checking. Example: Subject

Output:

• CreatedOrUpdatedPurchaseOrder (object): The created or updated purchase order object containing id, Subject, Status, Vendor_Name, Grand_Total, Created_Time, Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Delete a Purchase Order

Deletes a single purchase order from Zoho CRM by ID

Input Parameters:

• PurchaseOrderId: The ID of the purchase order to delete (required). You can obtain this ID from Search Purchase Orders or Get Many Purchase Orders action. Example: 5725767000000649013

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).

Output:

• DeletedPurchaseOrder (object): The deleted purchase order object containing id and status ("deleted").
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get Many Purchase Orders

Retrieves a list of purchase orders from Zoho CRM with pagination

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number to retrieve (starts from 1). Default: 1.
• AdditionalFields: Additional fields to return (comma-separated). Use Zoho CRM field API names. Example: Custom_Field_1,Custom_Field_2

Output:

• PurchaseOrders (object-array): Array of purchase orders. Each object contains Id, Subject, Status, Vendor_Name, Contact_Name, Grand_Total, and other fields specified in AdditionalFields.
• Info (object): Pagination metadata: count (total records in response), more_records (boolean), page (current page), per_page (records per page).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get a Purchase Order

Retrieves a single purchase order from Zoho CRM by ID

Input Parameters:

• PurchaseOrderId: The ID of the purchase order to retrieve (required). You can obtain this ID from Search Purchase Orders or Get Many Purchase Orders action. Example: 5725767000000649013

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• AdditionalFields: Additional fields to return (comma-separated). Use Zoho CRM field API names. Example: Custom_Field_1,Custom_Field_2

Output:

• PurchaseOrder (object): The purchase order object containing Id, Subject, Status, Vendor_Name, Contact_Name, Grand_Total, Sub_Total, and other specified fields.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Search Purchase Orders

Search purchase orders in Zoho CRM using criteria or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Criteria: Search criteria expression (takes priority over Keyword). Format: (Field:Operator:Value). Operators: equals, starts_with, contains, greater_than, less_than. Examples: (Subject:starts_with:PO-) or (Status:equals:Created)and(Grand_Total:greater_than:5000)
• Keyword: Keyword search across multiple fields (used if Criteria is empty).
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number to retrieve (starts from 1). Default: 1.
• AdditionalFields: Additional fields to return (comma-separated). Use Zoho CRM field API names. Example: Custom_Field_1,Custom_Field_2

Output:

• PurchaseOrders (object-array): Array of purchase orders matching the search criteria. Each object contains Id, Subject, Status, Vendor_Name, Contact_Name, Grand_Total, and other fields.
• Info (object): Pagination metadata: count (total records in response), more_records (boolean), page (current page), per_page (records per page).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Update a Purchase Order

Updates an existing purchase order in Zoho CRM

Input Parameters:

• PurchaseOrderId: The ID of the purchase order to update (required). You can obtain this ID from Search Purchase Orders or Get Many Purchase Orders action. Example: 5725767000000649013

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Subject: The new subject/title of the purchase order (optional). Example: Office Supplies Order - Q1 2026
• Status: The new status of the purchase order (optional). Statuses: Created, Approved, Delivered, Cancelled, Rejected, Received
• VendorId: The new associated vendor ID (optional). You can obtain this ID from Get Many Vendors or Search Vendors action. Example: 5725767000000524001
• ContactId: The new associated contact person ID at the vendor (optional). You can obtain this ID from Get Many Contacts action. Example: 5725767000000515003
• DueDate: The new due/delivery date (optional). Format: YYYY-MM-DD. Example: 2026-12-31
• Description: Additional description or notes for this purchase order (optional). Example: Urgent delivery required
• AdditionalFields: Additional PO fields as an object (optional). Use Zoho CRM field API names as keys. Example: {"Carrier": "FedEx", "Tracking_Number": "1234567890"}

Output:

• UpdatedPurchaseOrder (object): The updated purchase order object containing id, Subject, Status, Vendor_Name, Grand_Total, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create an Invoice

Creates a single invoice in Zoho CRM with product details, addresses, and related records

Input Parameters:

• Subject: Invoice subject/title (required). A descriptive name identifying the invoice purpose. Example: Q1 2026 Software License
• ProductId: Product ID to invoice (required). Obtain via Get Many Products or Search Products. Example: 5725767000000323001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Status: Invoice status (optional). Determines the lifecycle stage. Options: Created, Approved, Delivered, Cancelled
• AccountId: Associated Account ID (optional). Obtain via Get Many Accounts or Search Accounts. Example: 5725767000000524001
• ContactId: Associated Contact ID (optional). Obtain via Get Many Contacts or Search Contacts. Example: 5725767000000515003
• InvoiceDate: Invoice issue date (optional). Format: YYYY-MM-DD. Example: 2026-01-16
• DueDate: Payment due date (optional). Format: YYYY-MM-DD. Example: 2026-02-16
• Quantity: Product quantity (optional). Must be positive. Default: 1. Example: 5
• ListPrice: Unit price of the product (optional). Default: 0. Example: 99.99
• Description: Additional notes for the invoice (optional). Appears on the invoice document. Example: Payment due within 30 days
• AdditionalFields: Additional invoice fields as an object (optional). Use Zoho CRM field API names as keys. To add multiple products, use: {"Invoiced_Items": [{"Product_Name": {"id": "xxx"}, "quantity": 2, "list_price": 100}]}
• DuplicateCheckFields: Fields for duplicate checking (optional, string type, default empty). Comma-separated field API names. If matching record exists, returns error. Example: Subject,Account_Name

Output:

• CreatedInvoice (object): The created invoice object containing id, Subject, Status, Account_Name, Contact_Name, Invoice_Date, Due_Date, Grand_Total, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create or Update an Invoice

Creates or updates an invoice in Zoho CRM using upsert

Input Parameters:

• Subject: Invoice subject/title (required). Used for duplicate checking in upsert operation.
• ProductId: Product ID to invoice (required). Obtain via Get Many Products or Search Products. Example: 5725767000000323001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Status: Invoice status (optional). Options: Created, Approved, Delivered, Cancelled
• AccountId: Associated Account ID (optional). Obtain via Get Many Accounts or Search Accounts. Example: 5725767000000524001
• ContactId: Associated Contact ID (optional). Obtain via Get Many Contacts or Search Contacts. Example: 5725767000000515003
• InvoiceDate: Invoice issue date (optional). Format: YYYY-MM-DD. Example: 2026-01-16
• DueDate: Payment due date (optional). Format: YYYY-MM-DD. Example: 2026-02-16
• Quantity: Product quantity (optional). Must be positive. Default: 1. Example: 5
• ListPrice: Unit price of the product (optional). Default: 0. Example: 99.99
• Description: Additional notes for the invoice (optional). Example: Payment due within 30 days
• AdditionalFields: Additional invoice fields as an object (optional). Use Zoho CRM field API names as keys. To add multiple products, use: {"Invoiced_Items": [{"Product_Name": {"id": "xxx"}, "quantity": 2, "list_price": 100}]}
• DuplicateCheckFields: Fields for duplicate checking (optional, string type, default empty). Comma-separated field API names. If matching record exists, updates it instead of creating. Example: Subject,Account_Name

Output:

• CreatedOrUpdatedInvoice (object): The created or updated invoice object containing id, Subject, Status, Account_Name, Contact_Name, Invoice_Date, Due_Date, Grand_Total, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Delete an Invoice

Deletes a single invoice from Zoho CRM by ID

Input Parameters:

• InvoiceId: The ID of the invoice to delete (required). You can obtain this ID from Search Invoices or Get Many Invoices action. Example: 5725767000000649013

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).

Output:

• DeletedInvoice (object): The deleted invoice object containing id and status ("deleted").
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get Many Invoices

Retrieves a list of invoices from Zoho CRM with pagination

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number to retrieve (starts from 1). Default: 1.
• AdditionalFields: Additional fields to return (comma-separated). Use Zoho CRM field API names. Example: Custom_Field_1,Custom_Field_2

Output:

• Invoices (object-array): Array of invoices. Each object contains Id, Subject, Status, Account_Name, Contact_Name, Grand_Total, and other fields specified in AdditionalFields.
• Info (object): Pagination metadata: count (total records in response), more_records (boolean), page (current page), per_page (records per page).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get an Invoice

Retrieves a single invoice from Zoho CRM by ID

Input Parameters:

• InvoiceId: The ID of the invoice to retrieve (required). You can obtain this ID from Search Invoices or Get Many Invoices action. Example: 5725767000000649013

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• AdditionalFields: Additional fields to return (comma-separated). Use Zoho CRM field API names. Example: Custom_Field_1,Custom_Field_2

Output:

• Invoice (object): The invoice object containing Id, Subject, Status, Account_Name, Contact_Name, Grand_Total, Sub_Total, Tax, Invoice_Date, Due_Date, and other specified fields.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Search Invoices

Search invoices in Zoho CRM using criteria or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Criteria: Search criteria expression (takes priority over Keyword). Format: (Field:Operator:Value). Operators: equals, starts_with, contains, greater_than, less_than. Examples: (Subject:starts_with:INV) or (Status:equals:Paid)and(Grand_Total:greater_than:5000)
• Keyword: Keyword search across multiple fields (used if Criteria is empty).
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number to retrieve (starts from 1). Default: 1.
• AdditionalFields: Additional fields to return (comma-separated). Use Zoho CRM field API names. Example: Custom_Field_1,Custom_Field_2

Output:

• Invoices (object-array): Array of invoices matching the search criteria. Each object contains Id, Subject, Status, Account_Name, Contact_Name, Grand_Total, and other fields.
• Info (object): Pagination metadata: count (total records in response), more_records (boolean), page (current page), per_page (records per page).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Update an Invoice

Updates an existing invoice in Zoho CRM

Input Parameters:

• InvoiceId: The ID of the invoice to update (required). Obtain via Search Invoices or Get Many Invoices. Example: 5725767000000649013

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Subject: New invoice subject/title (optional). Example: Q1 2026 Software License
• Status: New invoice status (optional). Options: Created, Approved, Delivered, Cancelled
• AccountId: New associated Account ID (optional). Obtain via Get Many Accounts or Search Accounts. Example: 5725767000000524001
• ContactId: New associated Contact ID (optional). Obtain via Get Many Contacts or Search Contacts. Example: 5725767000000515003
• InvoiceDate: New invoice date (optional). Format: YYYY-MM-DD. Example: 2026-01-16
• DueDate: New payment due date (optional). Format: YYYY-MM-DD. Example: 2026-02-16
• ProductId: Product ID for line item (optional). Obtain via Get Many Products or Search Products. Example: 5725767000000323001
• Quantity: Product quantity (optional). Must be positive. Default: 1. Example: 5
• ListPrice: Unit price of the product (optional). Default: 0. Example: 99.99
• Description: Additional notes for the invoice (optional). Example: Payment due within 30 days
• AdditionalFields: Additional invoice fields as an object (optional). Use Zoho CRM field API names as keys. Example: {"Tax": 50, "Discount": 100}

Output:

• UpdatedInvoice (object): The updated invoice object containing id, Subject, Status, Account_Name, Contact_Name, Invoice_Date, Due_Date, Grand_Total, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create a Vendor

Creates a single vendor in Zoho CRM

Input Parameters:

• VendorName: The company name of the vendor/supplier (required). Example: 'Acme Supplies Inc.'.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for US region. EU: https://www.zohoapis.eu, China: https://www.zohoapis.com.cn, India: https://www.zohoapis.in
• Email: Primary contact email for the vendor (optional). Must be a valid email format. Example: 'contact@acmesupplies.com'.
• Phone: Primary phone number for the vendor (optional). Supports various international formats. Example: '+1-555-123-4567'.
• Website: Vendor's website URL (optional). Must be a valid URL format. Example: 'https://www.acmesupplies.com'.
• City: City where the vendor is located (optional). Example: 'New York'.
• AdditionalFields: Additional vendor fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Street": "123 Main St", "Country": "United States", "GL_Account": "2000"}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). If a matching record is found, Zoho returns an error instead of creating a duplicate. Leave empty to skip duplicate check. Example: Email or Vendor_Name,Email

Output:

• CreatedVendor (object): The created vendor object containing id, Vendor_Name, Email, Phone, Website, City, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Create or Update a Vendor

Creates a new vendor or updates an existing vendor in Zoho CRM using upsert

Input Parameters:

• VendorName: The name of the vendor/supplier (required). Used for duplicate checking - if a vendor with this name exists, it will be updated instead of creating a new one. Example: 'Acme Supplies Inc.'.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Email: The email address of the vendor (optional). Must be a valid email format. Example: 'contact@acmesupplies.com'.
• Phone: The phone number of the vendor (optional). Supports various international formats. Example: '+1-555-123-4567'.
• Website: The website of the vendor (optional). Must be a valid URL format. Example: 'https://www.acmesupplies.com'.
• City: The city where the vendor is located (optional). Example: 'New York'.
• VendorId: The ID of an existing vendor to update (optional). If provided, updates the existing vendor directly. You can obtain this ID through: Search Vendors or Get Many Vendors action, or from the response of Create Vendor action.
• AdditionalFields: Additional vendor fields as an object (optional). Use Zoho CRM field API names as keys. Refer to Zoho CRM API documentation for field-specific data type requirements. Example: {"Description": "Main supplier", "Street": "123 Main St", "Country": "United States"}
• DuplicateCheckFields: Comma-separated field names for duplicate check (optional). When creating or updating, if a matching record is found by these fields, it will be updated instead of creating a new one. Leave empty to use default (Vendor_Name). Example: Email or Vendor_Name,Email

Output:

• CreatedOrUpdatedVendor (object): The created or updated vendor object containing id, Vendor_Name, Email, Phone, Website, City, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Delete a Vendor

Deletes a single vendor from Zoho CRM

Input Parameters:

• VendorId: The unique ID of the vendor to delete (required). You can obtain this ID from 'Search Vendors' or 'Get Many Vendors' action. Format: Zoho-generated numeric string (e.g., '4150868000001234567').

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).

Output:

• DeletedVendor (object): The deletion result object containing id (string, the deleted vendor's unique ID) and status (string, fixed value 'deleted').
• StatusCode (number): HTTP status code: 200 (success), -1 (parameter validation error), 429 (rate limited), 504 (timeout), or other HTTP status code.
• ErrorMessage (string): Error message if the request failed, empty string on success. Contains detailed error from Zoho API when available.

Get Many Vendors

Retrieves a paginated list of vendors from Zoho CRM

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number for pagination. Starts from 1. Default: 1.
• AdditionalFields: Comma-separated field names to include in results. Leave empty to retrieve default fields. Example: Field_1,Field_2

Output:

• Vendors (object-array): Array of Vendor objects. Each object contains: Id (string, unique identifier), Vendor_Name (string), Email (string), Phone (string), Website (string), GL_Account (string), Category (string), Street (string), City (string), State (string), Country (string), Zip_Code (string), Description (string), Owner (object with id and name), Created_Time (string, ISO 8601), Modified_Time (string, ISO 8601). Additional fields depend on AdditionalFields parameter.
• Info (object): Pagination metadata object containing: per_page (number, records per page), page (number, current page), count (number, total records in current page), more_records (boolean, true if more pages exist). Use more_records to determine if you need to fetch the next page.
• StatusCode (number): HTTP status code: 200 (success), -1 (parameter validation error), 429 (rate limited), 504 (timeout), or other HTTP status code.
• ErrorMessage (string): Error message if the request failed, empty string on success. Contains detailed error from Zoho API when available.

Get a Vendor

Retrieves a single vendor from Zoho CRM by its ID

Input Parameters:

• VendorId: The unique ID of the vendor to retrieve (required). You can obtain this ID from 'Search Vendors' or 'Get Many Vendors' action, or from the response of other vendor operations.

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Fields: Comma-separated list of field API names to retrieve (optional). Example: 'Vendor_Name,Email,Phone'. If not specified, all fields will be returned.

Output:

• Vendor (object): The vendor object containing core fields: id (string, unique identifier), Vendor_Name (string), Email (string), Phone (string), Website (string), City (string), State (string), Country (string), Description (string), Created_Time (string, ISO 8601), Modified_Time (string, ISO 8601), and Owner (object). Refer to Zoho CRM API documentation for complete field list.
• StatusCode (number): HTTP status code: 200 (success), -1 (parameter validation error), 429 (rate limited), 504 (timeout), or other HTTP status code.
• ErrorMessage (string): Error message if the request failed, empty string on success. Contains detailed error from Zoho API when available.

Search Vendors

Search vendors in Zoho CRM using criteria, email, phone, or keyword

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Criteria: Search criteria expression. Format: (Field:Operator:Value). Supported operators: equals, starts_with, contains, greater_than, less_than. Multiple conditions use AND/OR. Example: (Vendor_Name:starts_with:ABC)and(City:equals:Shanghai). Priority: Criteria > Email > Phone > Keyword.
• Email: Search by email address (exact match, optional). Lower priority than Criteria.
• Phone: Search by phone number (exact match, optional). Lower priority than Email.
• Keyword: Keyword search across multiple fields (optional). Lowest priority among search parameters.
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number for pagination. Starts from 1. Default: 1.
• AdditionalFields: Comma-separated field names to include in results. Leave empty to retrieve default fields. Example: Field_1,Field_2

Output:

• Vendors (object-array): List of vendors matching the search criteria. Each vendor object contains: Id (string, unique identifier), Vendor_Name (string), Email (string), Phone (string), Website (string), GL_Account (string), Category (string), Street (string), City (string), State (string), Country (string), Zip_Code (string), Description (string), Owner (object with id and name), Created_Time (string, ISO 8601), Modified_Time (string, ISO 8601). Additional fields depend on AdditionalFields parameter.
• Info (object): Pagination metadata object containing: per_page (number, records per page), page (number, current page), count (number, total records in current page), more_records (boolean, true if more pages exist). Use more_records to determine if you need to fetch the next page.
• StatusCode (number): HTTP status code: 200 (success), -1 (parameter validation error), 429 (rate limited), 504 (timeout), or other HTTP status code.
• ErrorMessage (string): Error message if the request failed, empty string on success. Contains detailed error from Zoho API when available.

Update a Vendor

Updates an existing vendor in Zoho CRM

Input Parameters:

• VendorId: The ID of the vendor to update (required). You can obtain this ID from Search Vendors or Get Many Vendors action. Example: 5725767000000524001

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• VendorName: The new name of the vendor (optional). Example: Acme Corporation
• Email: The new email address of the vendor (optional). Example: vendor@acme.com
• Phone: The new phone number of the vendor (optional). Example: +1-555-0123
• Website: The new website URL (optional). Example: https://www.acme.com
• City: The new city of the vendor (optional). Example: San Francisco
• AdditionalFields: Additional vendor fields as an object (optional). Use Zoho CRM field API names as keys. Example: {"Description": "Main supplier", "Country": "United States"}

Output:

• UpdatedVendor (object): The updated vendor object containing id, Vendor_Name, Email, Phone, Website, City, Created_Time, Modified_Time, and Owner.
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

Get Custom Module Data

Retrieves a paginated list of records from any Zoho CRM module (standard or custom). Use Get Modules to discover available module names. Ideal for bulk data retrieval from custom modules with full pagination support.

Input Parameters:

• ModuleName: The API name of the module to retrieve records from (required). Works with standard modules (Contacts, Leads, Deals, Accounts) and custom modules. Module names are case-sensitive and must match the Zoho CRM module API names exactly. You can obtain available module names through the Get Modules action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number for pagination. Starts from 1. Default: 1.
• AdditionalFields: Comma-separated API field names to add to default fields (id, Created_Time, Modified_Time, Owner). Leave empty to use only default fields. Example: field_1,field_2. Note: Use English API names, not UI display labels.

Output:

• Records (object-array): Array of record objects from the specified module. Each record contains default fields (id, Created_Time, Modified_Time, Owner) and additional fields if specified.
• Info (object): Pagination metadata: per_page (records per page), page (current page), count (records in response), more_records (whether more pages available).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error or status message. Empty when successful. When rate limited (429), includes retry wait time.

Get Module Fields

Retrieve all field information for a specified Zoho CRM module, including custom fields

Input Parameters:

• ModuleName: The API name of the module to retrieve fields for (required). Standard modules: Contacts, Leads, Deals, Accounts, etc. You can obtain available module names through the Get Modules action.

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.

Output:

• Fields (object-array): Array of field objects for the module. Each field contains: api_name (API identifier), field_label (display name), data_type (field data type), custom_field (boolean), system_mandatory (boolean), visible (boolean), read_only (boolean).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error or status message. Empty when successful. When rate limited (429), includes retry wait time.

Get Modules

Retrieves the list of modules from Zoho CRM

Options:

• ZohoUrl: Zoho CRM API base URL. Default: https://www.zohoapis.com (US). For EU use https://www.zohoapis.eu, for China https://www.zohoapis.com.cn, for India https://www.zohoapis.in.

Output:

• Modules (object-array): Array of module objects available in Zoho CRM. Each module contains: api_name (API identifier like 'Leads', 'Contacts'), module_name (display name), generated_type (module type), id (unique identifier).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error or status message. Empty when successful. When rate limited (429), includes retry wait time.

Search Custom Module Data

Search records in any Zoho CRM module (standard or custom) using criteria, email, phone, or keyword

Input Parameters:

• ModuleName: The API name of the module to search (required). Can be standard modules (Contacts, Leads, Deals, Accounts) or custom module names. Example: Contacts or My_Custom_Module

Options:

• ZohoUrl: Zoho CRM API base URL. Default works for most users (US region). Only change if using a different region: EU (https://www.zohoapis.eu), China (https://www.zohoapis.com.cn), India (https://www.zohoapis.in).
• Criteria: Search criteria expression (takes priority). Format: (Field:Operator:Value). Operators: equals, starts_with, contains, greater_than, less_than. Example: (Last_Name:equals:Zhang) or (Phone:starts_with:138)
• Email: Search by email address (exact match). Used if Criteria is empty.
• Phone: Search by phone number (exact match). Used if Criteria and Email are empty.
• Keyword: Keyword search across multiple fields. Used if all other search parameters are empty.
• PerPage: Number of records per page. Range: 1-200. Default: 200.
• Page: Page number to retrieve (starts from 1). Default: 1.
• AdditionalFields: Additional fields to return (comma-separated). Use Zoho CRM field API names. Example: Id,First_Name,Last_Name,Email,Phone

Output:

• Data (object-array): Array of records matching the search criteria. Each object contains fields from the module as specified by AdditionalFields parameter.
• Info (object): Pagination metadata: count (total records in response), more_records (boolean), page (current page), per_page (records per page).
• StatusCode (number): Operation result code: 200 (success), -1 (parameter error), 429 (rate limited), 504 (timeout), 503 (connection error), or HTTP status code.
• ErrorMessage (string): Detailed error description. Empty string when successful. When rate limited (429), includes retry wait time.

5. Example Usage

This section will guide you through creating a simple workflow to create a new lead in your Zoho CRM.

Workflow Overview:

Our example workflow consists of three nodes: Start → Zoho CRM → Answer. This workflow captures lead information and creates a new lead record in Zoho CRM.

Step-by-Step Guide:

1. Add the Tool Node:
   • Click the "+" button on the workflow canvas to add a new node.
   • Select the "Tools" tab in the popup panel.
   • Find and select "Zoho CRM" from the tool list.
   • In the list of supported operations, click "Create a Lead" to add this node to the canvas.
2. Configure the Node:
   • Click the newly added "Create a Lead" node. The configuration panel will open on the right side.
   • Credentials Configuration: At the top of the panel, locate the credentials field. Click the dropdown menu and select your pre-configured Zoho CRM credentials.
   • Parameter Configuration: Fill in the required parameters:
   • LastName: Enter the last name of the lead (required field). For example: 'Johnson'.
   • FirstName: Enter the first name (optional). For example: 'Sarah'.
   • Company: Enter the company name (optional). For example: 'Tech Solutions Inc.'.
   • Email: Enter the email address (optional). For example: 'sarah.johnson@techsolutions.com'.
   • Phone: Enter the phone number (optional). For example: '+1-555-0123'.
   • LeadSource: Select or enter the lead source (optional). For example: 'Web Download' or 'Trade Show'.
3. Run and Verify:
   • Once all required parameters are correctly filled, the error indicator on the canvas will disappear.
   • Click the "Test Run" button in the upper right corner of the canvas to execute the workflow.
   • After successful execution, click the log icon in the upper right corner to view the node's detailed input and output, verifying that the lead was created successfully.

Final Workflow:

After completing the above steps, your entire workflow is configured. Click "Test Run" and a new lead will be successfully created in your Zoho CRM with all the provided information.

6. FAQs

Q: What should I do if I encounter a 401 or 403 authentication error?

A: This typically indicates an authentication or authorization issue. Please check the following:

• Ensure your Zoho CRM credentials are correctly configured in GoInsight.
• Verify that your OAuth token has not expired. Zoho CRM tokens typically need to be refreshed periodically.
• Confirm that your Zoho CRM account has the necessary permissions to perform the requested operation.
• Check if you're using the correct regional API endpoint (US, EU, India, China, or Australia).

Q: How do I handle rate limiting (429 errors)?

A: Zoho CRM enforces API rate limits to ensure service stability. When you encounter a 429 error:

• The error message will include a "Retry-After" value indicating how many seconds to wait.
• Implement exponential backoff in your workflow logic.
• Consider reducing the frequency of API calls or batching operations when possible.
• Review Zoho CRM's API rate limit documentation for your specific plan tier.

Q: Which fields are required when creating records?

A: Required fields vary by record type:

• Lead: LastName (required)
• Contact: LastName (required)
• Account: AccountName (required)
• Deal: DealName and Stage (required)
• Product: ProductName (required)

Other fields are optional but recommended for better data quality. Your Zoho CRM administrator may have configured additional mandatory fields.

Q: How do I use custom fields?

A: Most create and update operations support an AdditionalFields parameter that accepts an object:

• Use the exact API name of your custom field as the key (e.g., Custom_Field_1__c).
• Ensure the value matches the field's data type (string, number, boolean, date, etc.).
• You can use the "Get Module Fields" or "Get Lead Fields" operations to discover available field names and their types.
• Example: {"Industry": "Technology", "Rating": "Hot", "Custom_Score__c": 85}

Q: What is the difference between "Create" and "Create or Update" operations?

A:

• Create: Always creates a new record. If a duplicate exists, it may create a duplicate record or return an error (depending on your duplicate checking settings).
• Create or Update (Upsert): Searches for an existing record based on specified criteria. If found, it updates the existing record; if not found, it creates a new one. This is useful for data synchronization scenarios.

7. Official Documentation

For more detailed information about Zoho CRM APIs, data models, and advanced features, please refer to:

Zoho CRM Official API Documentation