crms

This API fetches the details of the departments whose IDs are passed in the API request.

必填参数：query_params

Retrieve a photo for a record

必填参数：path_variables

This API fetches a single contact from your help desk portal.

必填参数：query_params、path_variables

This endpoint is used to update the tag details

必填参数：body、query_params、path_variables

This API lists the accounts associated with a particular contact.

必填参数：query_params、path_variables

Retrieves a list of records that were previously related to a parent record but have since been deleted. Useful for audit trails and data recovery scenarios.

必填参数：query_params、path_variables

This API lists the agents in a department.

必填参数：query_params、path_variables

To update an email notifications in your Zoho CRM organization.

必填参数：body、path_variables

This API updates multiple accounts at once.

必填参数：body、query_params

Creates a clone of the specified profile. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read

必填参数：body、path_variables

This API lists the accounts associated with a product

必填参数：query_params、path_variables

Sends an email using specific templates or custom content to a record in a given module.

必填参数：body、path_variables

This API lists a particular number of accounts, based on the limit specified.

必填参数：query_params

Auto-generated description for operation `Transfer And Delete Territory By Id`.

必填参数：body、path_variables

This API searches for accounts in your help desk.<br/> You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. <br/><br/> <a href='#Search'>Learn more about search and how it works.</a>

必填参数：query_params

Createbulkreadjob

必填参数：body

To fetch the limit and usage details of workflow rules and actions in your Zoho CRM account. Use this API to track how many rules and actions are configured and how many more you can create.

该工具无需必填参数，直接调用即可

This API fetches the details of a department from your help desk

必填参数：query_params、path_variables

To retrieve the total number of actions configured in the specified Workflow rules, including both instant and scheduled actions. The response includes a count of actions, categorized by action type.

必填参数：query_params

To retrieve the list of modules that are associated with&nbsp;Webhook actions&nbsp;in the current CRM account.

该工具无需必填参数，直接调用即可

This API searches for records in your help desk.<br/> You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values.<br/><br/> <a href='#Search'>Learn more about search and how it works.</a>

必填参数：query_params、path_variables

Auto-generated description for operation `Get Child Territories By Id`.

必填参数：path_variables

Update a Custom Field with related to specific module of Zoho CRM Account

必填参数：body、query_params、path_variables

This API merges two or more accounts.

必填参数：body、query_params、path_variables

To configure a Workflow rule

必填参数：body

This API creates an account in your help desk portal.

必填参数：body、query_params

To retrieve automation tasks configured in your Zoho CRM organization

必填参数：path_variables

This endpoint is used to add tags to record

必填参数：body、path_variables

This API associates products with a contact. Only a maximum of 10 products can be associated with a contact through a single API request.

必填参数：body、query_params、path_variables

Retrieve all available&nbsp;webhooks&nbsp;configured in your Zoho CRM account.

该工具无需必填参数，直接调用即可

Partially updates a module's display labels (singular and plural) and associated profile permissions. This operation only modifies the specified fields without affecting other module configuration. The operation is idempotent - calling it multiple times with the same payload produces the same result.

必填参数：body、path_variables

This API lists the accounts associated with a particular contact.

必填参数：query_params、path_variables

Deletes the association between a parent record and a specific related record. This operation deletes only the relationship link, not the actual record itself.

必填参数：path_variables

To create an automation task in your Zoho CRM organization.

必填参数：body

This API adds a department to your help desk portal.

必填参数：body、query_params

Retrieves comprehensive details of a specific layout by its unique identifier for a specified module in your Zoho CRM account. Returns layout configuration including sections, fields, profiles, and permissions. **Important Notes:** - The `profiles` array will be `null` if the user does not have "Module Customization" permission in their profile. - For Deals module: When the pipeline feature is enabled, multiple layouts exist per pipeline. Each pipeline can have its own set of layouts. - The `mode` parameter supports different values based on module type. Common modes include `business_card` and `quick_create`. - Score and Visit Summary sections are system-generated and read-only. **Prerequisite:** The Layout ID can be obtained from the Get All Layouts API.

必填参数：query_params、path_variables

Activates a single deactivated layout, making it available for use within the specified module. Optionally allows adding or removing profile associations during activation. Only one layout can be activated per request. This operation is idempotent - attempting to activate an already active layout returns an error (ALREADY_ACTIVATED).

必填参数：body、query_params、path_variables

This API fetches an account from your help desk portal.

必填参数：query_params、path_variables

Updates an existing CRM profile by ID. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read

必填参数：body、path_variables

Delete a custom field from a module. Field must not be used in workflows, approvals, scoring rules, or other configurations. Only one field can be deleted per request.

必填参数：query_params、path_variables

This API fetches the overall statistics of an account.

必填参数：query_params、path_variables

used to delete particular variables

必填参数：path_variables

This API fetches the details of an organization from your help desk.

必填参数：query_params、path_variables

This endpoint is used to get the number of records associated to the tag.

必填参数：query_params、path_variables

This endpoint is used to delete Tags

必填参数：path_variables

This API creates a contact in your help desk portal.

必填参数：body、query_params

Retrieves details of a specific note by its ID.

必填参数：path_variables

Webhooks in Zoho CRM allow you to send real-time data from Zoho CRM to external applications or services when specific events occur such as Record creation, update, or deletion.

必填参数：body

To update an existing field update action.

必填参数：body、path_variables

Auto-generated description for operation `Remove Territories To Record`.

必填参数：body、path_variables

Retrieve all fields metadata for modules. Examples and schemas derived from provided sample and schema files.

必填参数：query_params

Update multiple users. API exposed to customers

必填参数：body

Get the configuration of related lists for a specific module and layout

必填参数：query_params

Retrieve a list of all CRM roles in the organization

该工具无需必填参数，直接调用即可

Permanently deletes a specific note by its ID.

必填参数：path_variables

Update multiple CRM roles in the organization

必填参数：body

Delete all

该工具无需必填参数，直接调用即可

To retrieve usage statistics for Webhook actions executed in Zoho CRM over the last&nbsp;seven days.&nbsp;

必填参数：query_params

Create one or more new CRM roles in the organization

必填参数：body

Get the list of user groups associated with the specified user.

必填参数：path_variables

Retrieves the details of a specific CRM profile by ID. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read

必填参数：path_variables

Delete Multiple Workflow Rules

必填参数：query_params

To clone a record in a module.

必填参数：body、path_variables

To update existing entities or records in a specified module with the recordID

必填参数：body、path_variables

Delete a photo for a record

必填参数：path_variables

To get the details of a specific record with its unique record ID.

必填参数：path_variables

Deletes an existing CRM profile by ID. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.delete

必填参数：query_params、path_variables

Retrieves a paginated list of records from a specific related list of a parent record in a CRM module. Supports filtering by fields and conditional requests using If-Modified-Since header.

必填参数：query_params、path_variables

Removes relationships between a parent record and multiple records in a specified related list, identified by their IDs in the query parameter. This operation deletes only the relationship links, not the actual records themselves. The target records remain intact in their respective modules.

必填参数：query_params、path_variables

To get details of given assignment rule

必填参数：query_params、path_variables

Retrieve the&nbsp;webhooks&nbsp;configured in your Zoho CRM account.

必填参数：path_variables

To retrieve usage statistics for email notification actions executed in Zoho CRM over the last&nbsp;seven days.&nbsp;

必填参数：query_params

Update an existing CRM role with new information

必填参数：body、path_variables

To delete one or more webhooks configured in your Zoho CRM account. You can delete up to 10 webhooks in a single API call.

必填参数：query_params

Get the number of users for the type.(API exposed to customers)

该工具无需必填参数，直接调用即可

Auto-generated description for operation `Update Territory`.

必填参数：body、path_variables

Update a custom layout in Zoho CRM. You can rename the layout, add/remove profile permissions, enable/disable business card, create/update/delete sections, and add/update/delete/move fields within sections. Limits: Maximum 5 sections per request and maximum 5 fields total across all sections per request.

必填参数：body、query_params、path_variables

Delete a user by ID. API exposed to customers

必填参数：path_variables

Enables users to update a specific field value across multiple records within a CRM module.

必填参数：body、path_variables

Retrieves comprehensive details of all layouts associated with a specified module in your Zoho CRM account. Returns layout configuration including sections, fields, profiles, and permissions in a single response without pagination. **Important Notes:** - The `profiles` array will be `null` if the user does not have "Module Customization" permission in their profile. - For Deals module: When the pipeline feature is enabled, multiple layouts exist per pipeline. Each pipeline can have its own set of layouts. - The `mode` parameter supports different values based on module type. Common modes include `business_card` and `quick_create`. - Score and Visit Summary sections are system-generated and read-only. - All layouts for the module are returned in a single response; pagination is not supported.

必填参数：query_params

To get the Company Details

该工具无需必填参数，直接调用即可

Create a Record in a specific module

必填参数：body、path_variables

To delete a specific email notification configured in your Zoho CRM account.

必填参数：path_variables

Fetches the full content of rich text fields for multiple records. The 'fields' parameter is mandatory and supports a maximum of 8 rich text fields.

必填参数：query_params、path_variables

This endpoint is used to create tags

必填参数：body、query_params

Delete the organization photo

该工具无需必填参数，直接调用即可

To update existing entities or records in a specified module.

必填参数：body、path_variables

Deactivates an active layout and transfers its configuration (profile associations, permissions, field mappings) to another active layout within the same module. At least one active layout must remain in the module. This operation is idempotent - attempting to deactivate an already deactivated layout returns an error (ALREADY_DEACTIVATED).

必填参数：query_params、path_variables

To update an automation task in your Zoho CRM organization.

必填参数：body、path_variables

The Upsert API allows you to insert a new record or update an existing one based on duplicate check field values.

必填参数：body、path_variables

Updates a specific related record's properties.

必填参数：body、path_variables

to get tags from a module

必填参数：query_params

Updates an existing workflow rule with partial data.

必填参数：body、path_variables

Auto-generated description for operation `Update Territory`.

必填参数：body

Retrieves the list of CRM profiles with metadata. **Scopes:** * ZohoCRM.settings.profiles.all * ZohoCRM.settings.profiles.read

该工具无需必填参数，直接调用即可

To get a single user based on the provided user ID.

必填参数：path_variables

Permanently deletes a specific record from the module using its unique record ID.

必填参数：path_variables

This API deletes the given spam tickets

必填参数：body、query_params

To delete a field update action.

必填参数：path_variables

This API lists a particular number of tickets, based on the limit specified.

必填参数：query_params

Retrieves details of a specific record that is related to a parent record. Returns the record data along with pagination information if applicable.

必填参数：query_params、path_variables

This API fetches the resolution history of a ticket

必填参数：query_params、path_variables

To retrieve the list of Workflow rules

该工具无需必填参数，直接调用即可

This API creates a ticket in your helpdesk.

必填参数：body、query_params

Get Variables by ID

必填参数：path_variables

This API closes multiple tickets at once.

必填参数：body、query_params

This API modifies an existing comment. To include an @mention, follow this format: zsu[@user:{zuid}]zsu.

必填参数：body、query_params、path_variables

Updates multiple related records' specific properties in a specified related list.

必填参数：body、path_variables

This API fetches details of all actions - called events - performed on a ticket and in the sub-tabs on the ticket detail page. To view a detailed documentation for this API, visit this page: https://help.zoho.com/portal/en/kb/desk/for-developers/rest-apis/articles/get-ticket-history-api-explained-in-detail

必填参数：query_params、path_variables

This API fetches a single ticket from your helpdesk.

必填参数：query_params、path_variables

To create a field update action in the Automation module. This action modifies field values when triggered by workflows, blueprints, or approval processes.

必填参数：body

This API lists tickets received from a specific account.

必填参数：query_params、path_variables

This helps in fetching all the variables

该工具无需必填参数，直接调用即可

This API fetches a ticket comment from your help desk portal.

必填参数：query_params、path_variables

Auto-generated description for operation `Remove Territories To Records`.

必填参数：body、path_variables

This API lists tickets received from a specific products.

必填参数：query_params、path_variables

This endpoint is used to dissociate tags from records

必填参数：body、path_variables

This API gets the archived tickets list in given department.

必填参数：query_params

Fetches the full content of rich text fields for a specific record. If the 'fields' parameter is not provided, all rich text fields in the module will be fetched.

必填参数：path_variables

This API returns the number of tickets in a particular view.

必填参数：query_params

Updates existing modules in the CRM. Allows modification of module labels and profile assignments. This operation is idempotent; the same request can be safely repeated. Supports batch updates - multiple modules can be updated in a single request. Returns 200 when all modules update successfully, or 207 Multi-Status when some succeed and others fail.

必填参数：body

This API deletes a comment.

必填参数：query_params、path_variables

To create custom fields in a module in your Zoho CRM account.

必填参数：body、query_params

This API searches for tickets in your help desk.<br/> You can provide multiple values separated by commas, and the search will be performed on the field using any of the provided values. <br/><br/> <a href='#Search'>Learn more about search and how it works.</a>

必填参数：query_params

To retrieve detailed information about webhook execution failures in your Zoho CRM organization.

该工具无需必填参数，直接调用即可

This API lists a particular number of tickets that are associated to you from your help desk, based on the limit specified.

必填参数：query_params

Put API with Tag id in request body

必填参数：body、query_params

This API splits an incoming ticket thread into a new ticket.

必填参数：query_params、path_variables

Fetches metadata for CRM modules including configuration, capabilities, and structural information. Supports filtering by feature name to retrieve modules associated with specific features, or by status (e.g., `system_hidden`) to return modules matching that status. When both `status` and `feature_name` are provided, modules must satisfy both criteria (AND logic). Expected latency: ~60ms.

该工具无需必填参数，直接调用即可

This API splits an incoming ticket thread into a new ticket.

必填参数：query_params、path_variables

Retrieve details of a specific CRM role by its identifier

必填参数：path_variables

This API deletes a resolution added to a ticket.

必填参数：query_params、path_variables

Get Timelines

必填参数：path_variables

This API lists a particular number of threads and comments recorded on a ticket, based on the limit specified.

必填参数：query_params、path_variables

Updates a specific note by its ID. Either note content or note title must be provided (at least one is mandatory).

必填参数：body、path_variables

This API merges two different tickets.

必填参数：body、query_params、path_variables

Updates one or more existing note records. Either note content or note title must be provided (at least one is mandatory) for each note.

必填参数：body

This API deletes all spam tickets.

必填参数：body、query_params

Retrieve all available field updates

该工具无需必填参数，直接调用即可

This API updates the details of an existing ticket.

必填参数：body、query_params、path_variables

To retrieve the email notifications configured in your Zoho CRM organization.

必填参数：path_variables

This API marks tickets as spam.

必填参数：body、query_params

To retrieve the details of a specific Workflow rule in your Zoho CRM account.

必填参数：path_variables

This API maps tickets with help articles to automatically suggest the same articles for similar tickets that arrive later.

必填参数：body、query_params、path_variables

To get all assignment rules

该工具无需必填参数，直接调用即可

This API helps move a ticket from one department to another. @Note:@ The departmentId query parameter will be deprecated soon. Therefore, going forward, the departmentId attribute must be passed in the body of the API request.

必填参数：body、query_params、path_variables

Auto-generated description for operation `Asssign Territories To Records`.

必填参数：body、path_variables

This API fetches the ticket history of an account.

必填参数：query_params、path_variables

This endpoint is used to merge two tags

必填参数：body、path_variables

This API deletes all spam tickets.

必填参数：body、query_params

Permanently deletes one or more records from the specified module using comma-separated record IDs. Returns per-item results for bulk operations.

必填参数：path_variables

This API fetches details related to the resolution of a ticket.

必填参数：query_params、path_variables

To update an existing webhook available in your Zoho CRM account.

必填参数：body、path_variables

This API marks a ticket as read by the user.

必填参数：query_params、path_variables

Retrieve the organization photo

该工具无需必填参数，直接调用即可

This API returns the number of tickets assigned to multiple agents.

必填参数：query_params

Auto-generated description for operation `Delete Territories`.

该工具无需必填参数，直接调用即可

This API helps move a ticket from one department to another. @Note:@ The departmentId query parameter will be deprecated soon. Therefore, going forward, the departmentId attribute must be passed in the body of the API request.

必填参数：body、query_params、path_variables

To delete automation tasks configured in your Zoho CRM account.

必填参数：path_variables

This API merges two different tickets.

必填参数：body、query_params、path_variables

Delete an existing CRM role and transfer users to another role

必填参数：query_params、path_variables

This API fetches details related to the response and resolution times of a ticket.

必填参数：query_params、path_variables

Auto-generated description for operation `Transfer And Delete Territories`.

必填参数：body

This API adds a comment to a ticket. To include an _@mention_, follow this format: _zsu[@user:{zuid}]zsu_.

必填参数：body、query_params、path_variables

Get Workflow Rule actions count for each module

该工具无需必填参数，直接调用即可

This API updates multiple tickets at once.

必填参数：body、query_params

Converts the record into another inventory module type depending on the parent module:Quotes -> Sales Orders, Invoices :Sales Orders -> Invoices.

必填参数：body、path_variables

This API updates multiple tickets at once.

必填参数：body、query_params

To get all users based on the provided parameters.

该工具无需必填参数，直接调用即可

This API lists a particular number of tickets that are associated to you from your help desk, based on the limit specified.

必填参数：query_params

To retrieve the complete configuration metadata details for workflows.This includes the list of available triggers for the module, the actions supported for each trigger, and their limits and properties.&nbsp;

必填参数：query_params

This API lists a particular number of tickets, based on the limit specified.

必填参数：query_params

To update custom fields in your Zoho CRM account.

必填参数：body、query_params

This API lists tickets received from a specific contact.

必填参数：query_params、path_variables

This endpoint is used to associate tags to records

必填参数：body、query_params、path_variables

This API marks a ticket as unread by the user.

必填参数：query_params、path_variables

Permanently deletes one or more notes using comma-separated note IDs.

该工具无需必填参数，直接调用即可

This API updates the resolution field of a ticket.

必填参数：body、query_params、path_variables

Getbulkreadjobdetails

必填参数：path_variables

This API suggests help articles that could be relevant to resolving a ticket.

必填参数：query_params、path_variables

Searches records matching your criteria within a CRM module. Supports criteria queries, email/phone/word searches. At least one search parameter required. Max 2,000 records, 15 criteria conditions. Newly created records may have indexing delays.

必填参数：path_variables

This API gets the archived tickets list in given department.

必填参数：query_params

Retrieves complete metadata for a specific CRM module identified by its API name. Returns comprehensive configuration including fields, layouts, profiles, related lists, custom views, and module capabilities.

必填参数：path_variables

This API moves tickets to the Recycle Bin

必填参数：body、query_params

Creates a single custom module in the CRM. Requires the Crm_Implied_Customize_Zoho_CRM permission. This operation is not idempotent; submitting the same api_name multiple times will result in validation errors. Only one module can be created per request; batch creation is not supported.

必填参数：body

To create an email notification action by defining its name, associated module, email template, sender details, and recipients. These actions can be linked to automation rules so that emails are automatically triggered when the specified conditions are met.

必填参数：body

Fetches the total number of records in a specified module. The count can be filtered using `cvid` (Custom View ID) or one of the search parameters (`criteria`, `phone`, `email`, `word`). **Important Constraint (Zoho Documentation):** You can only include **either** `cvid` **or** one of the search parameters (`criteria`, `phone`, `email`, `word`) in a single request. Combining `cvid` with any search parameter will result in an `AMBIGUITY_DURING_PROCESSING` error (HTTP 400).

必填参数：path_variables

Deletes a custom layout from a module in Zoho CRM. When deleting a layout that has associated records, you must specify a `transfer_to` layout ID to transfer those records. If the layout has an associated pipeline, you must also provide `pipeline` and `stage` parameters. The `transfer_to` parameter is only optional when the layout is deactivated and has no records associated with it. Note: The standard layout cannot be deleted.

必填参数：query_params、path_variables

To delete email notifications configured in your Zoho CRM account.

该工具无需必填参数，直接调用即可

Auto-generated description for operation `Update Territory`.

必填参数：path_variables

This API lists the mailReplyAddresses configured in your help desk portal.

必填参数：query_params

This API creates a root category (i.e., parent category) in your knowledge base.

必填参数：body、query_params

This endpoint is used to remove tags from records

必填参数：body、path_variables

This API adds users to a particular group.

必填参数：body、query_params、path_variables

Deletes an existing workflow rule by its ID.

必填参数：path_variables

This API sends an email reply. The from address in the email must be a from address configured in your help desk portal.

必填参数：body、query_params、path_variables

Retrieves the current status and progress metrics of an asynchronous mass update job initiated via POST /crm/v8/\{module\}/actions/mass_update. Returns record counts and current job state.

必填参数：query_params、path_variables

This API adds a new from address to the specified department.

必填参数：body

Update single user by ID. API exposed to customers

必填参数：body、path_variables

This API drafts an email reply. The from address in the email must be a from address configured in your help desk portal.

必填参数：body、query_params、path_variables

Creates one or more note records.

必填参数：body

Auto-generated description for operation `Create Territories`.

必填参数：body

To update the execution order of Workflow rules in a specific module in Zoho CRM. By default, workflow rules are executed in the order in which they are created.

必填参数：body

updates variables based on id

必填参数：body、path_variables

Auto-generated description for operation `Get Associated Users Count`.

该工具无需必填参数，直接调用即可

this creates variables.

必填参数：body

To get the list of available records from a module

必填参数：query_params、path_variables

Create a new user in the organization. API exposed to customers

必填参数：body

To retrieve the list of automation tasks configured in your Zoho CRM organization.

该工具无需必填参数，直接调用即可

To delete multiple field update actions configured

必填参数：query_params

This API lists a particular number of contacts, based on the limit specified.

必填参数：query_params

Retrieves the details of the field-update action for the specified fieldUpdate ID.

必填参数：query_params、path_variables

This API lists all organizations which can be accessed using the current Oauth token.

必填参数：query_params

Updates all variables

必填参数：body

This API searches for the activities in your help desk portal.<br/> You can provide comma-separated values, which will perform the search on the field using any of the provided values.<br/><br/> <a href='#Search'>Learn more about search and how it works.</a>

必填参数：query_params

This API updates multiple contacts at once.

必填参数：body、query_params

This API fetches details of agents via the agent IDs passed in the API request.

必填参数：query_params

Retrieve the deleted records for the module. This endpoint can retrieve both permanently deleted records and temporarily deleted records from the recycle bin.

必填参数：path_variables

This API helps you manually sort articles in your knowledge base. Only leaf categories that have a maximum of 1000 articles can be repositioned.

必填参数：body、query_params、path_variables

Retrieves a list of territories.

该工具无需必填参数，直接调用即可

This API lists a particular number of agents, based on the limit specified.

必填参数：query_params

Executes a COQL select query to fetch records data.

必填参数：body

This API returns information from all modules or a specific module, based on the value of the module query param.

必填参数：query_params

To delete one webhooks configured in your Zoho CRM account.

必填参数：path_variables

This API lists a particular number of departments, based on the limit specified.

必填参数：query_params

`Get Territory By Id`

必填参数：path_variables

This API lists details of specific contacts, based on the IDs passed in the request.

必填参数：query_params

Retrieve metadata of a specific custom field in a module using the field ID.

必填参数：query_params、path_variables

This API activates agents in your help desk.

必填参数：body、query_params

Auto-generated description for operation `Asssign Territories To Record`.

必填参数：body、path_variables

This API lists a particular number of accounts, based on the limit specified.

必填参数：query_params

Returns a paginated list of email notification definitions. Supports filtering by module, related_module, feature_type, and arbitrary filters. Pagination: page starts at 1 (default 1). per_page default is 200 (maximum allowed). Use more_records=true to fetch subsequent pages. A 204 response indicates no notifications match the supplied filters.

该工具无需必填参数，直接调用即可