Zoho CRM

Disable notification channels. To disable one or more notification channels in your Zoho CRM organization.

Delete one or more appointment records. To delete one or more appointment records in your Zoho CRM organization. Note that this API will not delete any deals created on the completion of the deleted appointments.

Delete an Appointment by ID. To delete a single appointment record from your Zoho CRM organization by its unique ID. Note that this operation will not delete any deals created upon completion of the appointment.

Delete records from a specified module. To permanently delete more records from the specified module in your Zoho CRM organization, use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs. A maximum of 100 records can be deleted per API call. By default, all workflows related to this API are executed. All subforms related to...

Deal Contact Roles. Remove one or more contact role associations from a deal using their relation IDs.

Deal Contact Roles. Remove a specific contact-deal relation using the contact identifier in the path.

Delete an Email Draft. Deletes the specified email draft for the given record.

Delete a record photo. To delete the photo associated with a specific record in your Zoho CRM organization.

Delete a specific record by ID. To permanently delete a specific record by its unique ID from the specified module in your Zoho CRM organization. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.

Revoke sharing on a record. To revoke all sharing on a specific record in a module of your Zoho CRM organization. Use this operation to remove access that was previously granted to users, roles, or groups through record-level sharing.

Delete Link Attachment. Deletes a link attachment associated with a specific record in a module. Note that only link attachments can be deleted using this endpoint; file attachments cannot be deleted through this API.

Remove lock from a locked record. To remove the lock from a locked record in the specified module of your Zoho CRM account.

Delink related records. To delink multiple records from a parent record's related list in your Zoho CRM organization. This operation removes only the relationship links - the related records themselves remain intact in their respective modules.

Delink a related record. To delink a specific related record from a parent record in your Zoho CRM organization. This operation removes only the relationship link - the related record itself remains intact in its module.

Related Notes. Deletes one or more notes associated with a specific parent record using comma-separated note IDs in the query parameter.

Related Note. Deletes a specific note record associated with a parent record using the note ID in the path.

Unlink Emails from Deals. To unlink deals from one or more of a contact's emails. An email will only be linked to a single deal at a time. When you call this API, the specified email(s) will be unlinked from them. The user's profile requires 'View' permission for Deals and Contacts modules to use this API.

Unlink Deal Email. Unlinks an email from a specified record in CRM.

Delete Contact Roles. Deletes one or more contact roles by their unique identifiers in your Zoho CRM organization.

Delete a Contact Role. Deletes a specific contact role by its unique identifier in your Zoho CRM organization.

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

Delete a Specific Note. Permanently deletes a specific note by its ID.

Delete the organization photo. To delete the organization photo from your Zoho CRM organization.

Delete one or more service records. To delete one or more service records from your Zoho CRM organization. All appointments associated with the deleted services are also deleted; however, deals created upon completion of those appointments are not deleted.

Delete a service record by ID. To delete a service record from your Zoho CRM organization by its unique ID. When a service record is removed, all appointments associated with that service are also removed; however, deals created upon completion of an appointment under the service are not affected.

Delete an Assignment Rule. To delete a single Assignment Rule from your Zoho CRM organization.

Delete a Cadence. To delete a Cadence and its associated records from your Zoho CRM organization. Deleting a Cadence removes all related action records, including workflow tasks, email notifications, and WhatsApp notifications, as well as process states and flow transitions. Pending enrollment schedules are removed, but record-level...

To delete multiple field update actions. Deletes multiple Field Update actions specified by their IDs. Specify the action IDs as a comma-separated list using the ids query parameter. You can delete a maximum of 10 actions in a single request. Field Update actions associated with active automation rules or marked as read-only cannot be deleted. Use the Get...

Delete Field Update. Deletes a single field update action identified by the path ID. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) to retrieve the field update ID. Actions associated with active automation rules return a NOT_ALLOWED error, and read-only actions cannot be deleted.

Scoring Rules. Permanently deletes multiple scoring rules

Delete a scoring rules by ID. Permanently deletes a single scoring rule identified by ruleId

Deactivate a scoring rule. Deactivates an active scoring rule identified by ruleId, suspending its scoring evaluation without deleting it.

Delete automation task definitions by IDs (bulk). PURPOSE: Deletes one or more automation task definitions by their IDs. MANDATORY: ids query parameter (comma-separated task IDs, max 10). KEY CONSTRAINTS: Tasks associated with active workflow rules, approval processes, or blueprints cannot be deleted (returns NOT_ALLOWED error). Returns per-task success/error status....

Automation Task. PURPOSE: Deletes a single automation task definition by its ID. MANDATORY: id path parameter (string - automation task definition ID, not a Task record ID). KEY CONSTRAINTS: Tasks associated with active workflow rules, approval processes, or blueprints cannot be deleted (returns NOT_ALLOWED). Returns success/error...

Delete one or more webhooks. To delete one or more webhook actions configured in your Zoho CRM account. Up to 10 webhooks can be deleted in a single API call using the ids query parameter. Read-only webhooks created by Zoho extensions cannot be deleted. Webhooks associated with active Workflow Rules, Approval Processes, or Blueprints cannot be...

Delete a webhook by ID. To delete a specific webhook configured in your Zoho CRM organization using its unique ID. Read-only webhooks created by Marketplace extensions cannot be deleted. Webhooks associated with active Workflow Rules, Approval Processes, Blueprints, or Command Center also cannot be deleted.

Delete One or More Workflow Rules. To delete one or more workflow rules from your Zoho CRM organization. You can delete up to ten workflow rules in a single API call; when some deletions succeed and others fail, the API responds with a 207 Multi-Status.

Delete a workflow rule by ID. To delete a workflow rule from your Zoho CRM organization by its unique ID. Locked workflow rules cannot be deleted.

Delete a shift hour. Deletes the shift hour identified by the shift path parameter. Once deleted, the shift hour configuration and all of its user assignments are removed.

Delete Custom Views. To delete one or more Custom Views from a specified module in your Zoho CRM organization.

Delete Duplicate Check Preference. To delete the duplicate check preference configured for the Leads module in your Zoho CRM organization.

Delete a custom field. To delete a custom field from a module in your Zoho CRM account. The field must not be used in workflows, approvals, scoring rules, or other configurations before deletion.

Delete a picklist field option. Delete picklist field option

Delete a Global Picklist. Deletes a single global picklist by numeric id. This request is asynchronous: a 202 Accepted indicates deletion has been scheduled and the response includes a job_id in details. There is no status-check endpoint currently. If the provided id is not present or deletion has already been scheduled, a 400 Bad Request is...

Delete a Global Picklist by ID. Deletes a single global picklist identified by the path parameter {id }. This request is asynchronous: a 202 Accepted indicates deletion has been scheduled and the response contains a job_id in details. There is no status-check endpoint. A 400 Bad Request is returned for invalid id, deletion already scheduled...

Holiday. To permanently delete a holiday from Zoho CRM using its unique identifier. The deletion cannot be undone.

Delete a custom layout. To delete a custom layout from a module in your Zoho CRM organization. When the layout being deleted has associated records, a target layout must be specified to receive the transferred records and profile associations. If the layout has an associated pipeline, the target pipeline and stage must also be provided....

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

Delete a field dependency. To delete a specific field dependency from a layout in your Zoho CRM organization.

delete portal users. To delete one or more portal users from your Zoho CRM organization for the specified portal and user type.

Delete user type. Deletes the specified portal user type from the portal. If portal users are assigned to this user type, provide transfer_To with the ID of another user type to transfer them before deletion.

Profile. Transfers all users of the profile identified by {id} to the profile specified by the transfer_to query parameter, then permanently deletes the source profile. System profiles (Administrator, Standard) cannot be deleted. See [Transfer Users and Delete a...

Delete record locking configuration. Deletes the record locking configuration(s) for the specified module using the provided configuration IDs.

Delete specific record locking configuration. Deletes a specific record locking configuration using the configuration ID provided in the URL path.

Delete recycle-bin records. To permanently delete one or more records from the Recycle Bin in your Zoho CRM account. When deleting a parent record, Zoho CRM also removes all its associated child records from the Recycle Bin, such as Notes and Attachments. When the total number of records to delete is 1000 or fewer, the operation completes...

Delete a recycle-bin record permanently. To permanently delete a single record from the Recycle Bin in your Zoho CRM account using its unique ID. Deleting a parent record also removes all its associated child records from the Recycle Bin, such as Notes and Attachments. This operation is irreversible - the record cannot be restored after deletion. When the...

Delete a role. Deletes a role in your Zoho CRM organization and moves its users to another role.

Delete tag by ID. To delete a tag by its ID from your Zoho CRM organization.

Delete territories. To delete one or more territories from your Zoho CRM organization. The territories to delete are specified using the ids query parameter. Deleting a territory is irreversible; child territories must be transferred before a parent territory can be deleted.

Delete a territory by ID. To delete a specific territory from your Zoho CRM organization using its unique ID.

Territory Users. To disassociate one or more users from a territory in your Zoho CRM organization.

Territory User. To disassociate a specific user from a territory in your Zoho CRM organization.

Delete Unsubscribe Link by ID. To delete a specific unsubscribe link. Note that the default unsubscribe link cannot be deleted.

Delete a user group. To delete an existing user group from your Zoho CRM organization. The deletion may be immediate or scheduled for background processing, depending on group size and active references.

Delete variables. Deletes one or more CRM variables by their IDs. Pass variable IDs as a comma-separated list in the ids query parameter, or pass rids in the rids query parameter. A variable that is associated with other features such as email templates, webhooks, or functions cannot be deleted until the association is removed....

Specific variable. Deletes a specific CRM variable identified by its ID. A variable that is associated with other features such as email templates, webhooks, or functions cannot be deleted until the association is removed. Requires the ZohoCRM.settings.variables.DELETE scope.

Delete Zia Enrichment Configuration for a specific module. Deletes a Zia Enrichment Configuration for a specific module by ID. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve module ID.

Delete a user from the organization. To delete a specific user from your Zoho CRM organization, submit a DELETE request with the target user ID. Only one user can be removed per request, and certain protected user types — including support, system, Digital Employee, and primary contact users — cannot be deleted.

Remove territories from a user. To remove one or more territories from a user in your Zoho CRM organization.

Remove territory from a user. To remove a specific territory from a user in your Zoho CRM organization.

List active notification channels. To retrieve the list of active notification channels configured for your Zoho CRM organization.

List available REST APIs. To retrieve the list of available REST API endpoints in your Zoho CRM organization for a specific API version. You can filter the results by module, OAuth scope, or request method using the filters parameter.

Get Appointment Records. To retrieve appointment records from your Zoho CRM organization. Use the page and per_page parameters to paginate up to 2,000 records, or use the page_token received in a prior response to paginate beyond 2,000 records up to a maximum of 100,000. Each request returns a maximum of 200 records. Subform data is not...

Get an Appointment Record by ID. To retrieve the details of a single appointment record from your Zoho CRM organization.

Get records from a specified module. Retrieves records from the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name. Use 'sort_by' and 'sort_order' to control the sorting of records. To fetch up to 2000 records, use 'page' (1-10) and 'per_page'...

Get mass change owner job status. To retrieve the status of a previously scheduled mass change owner job in your Zoho CRM organization. The OAuth scope enforced is specific to the target module (for example, ZohoCRM.change_owner.leads.READ for Leads); modules without a dedicated scope fall back to a generic custom-module scope.

Retrieve mass delete job status. To retrieve the status and record counts of a previously scheduled mass delete job in your Zoho CRM organization.

Get mass update job status. To retrieve the current status and record-processing counts of an asynchronous mass update job that was previously scheduled in your Zoho CRM organization. The job is identified by the job_id returned in the response of the scheduler-type mass update request. The response reports the job state along with the total...

Invite portal users. To retrieve the status of a scheduled portal invitation job in your Zoho CRM organization using the job identifier returned when invitations were scheduled.

Deal Contact Roles. Retrieve contact roles associated with a deal.

Deal Contact Roles. Retrieves the contact role relation for a specific contact associated with a deal.

Get Merge Job Status. To retrieve the status of a scheduled merge job in your Zoho CRM organization. Use the optional job_id query parameter to filter results to a specific job.

List Email Drafts for a Record. Retrieves the list of email drafts associated with the specified record in the given module.

Get an Email Draft. Retrieves the specified email draft for the given record in the module.

Get a record photo. To retrieve the photo associated with a specific record in your Zoho CRM organization.

Get a record by ID from a specified module. To retrieve the details of a specific record by its unique ID from the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name. Use the [Get Records API](record.yaml#$.paths./module.get) to retrieve the record IDs.

Get Timelines. To retrieve a paginated list of timeline entries for a specific record in your Zoho CRM organization. Each timeline entry captures an audited event such as field changes, ownership transfers, workflow actions, Approval Process progressions, Scoring Rule updates, and signal events from extensions.

Get deleted records from a specified module. To retrieve the list of deleted records from the specified module in your Zoho CRM organization, including records in the recycle bin and permanently deleted records. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name.

Search Records by Criteria, Word, Email, or Phone. To search for records within a specified module in your Zoho CRM organization using criteria-based conditions, full-text word search, or lookup by email or phone number.

Module Record Count. To retrieve the total number of records in a specified Zoho CRM module, optionally filtered by a Custom View or search criteria. The count can be filtered using cvid (Custom View ID) or search parameters (criteria, email, phone, or word). These two filter groups are mutually exclusive - they cannot be combined in the...

Rich text field content for multiple records. Retrieves the full content of rich text multi-line fields for multiple records in a single request. Both the 'ids' and 'fields' query parameters are mandatory. You can specify up to 200 record IDs in the 'ids' parameter and up to 8 rich text field API names in the 'fields' parameter. This API exclusively fetches rich...

Rich text field content for a specific record. Retrieves the full content of rich text multi-line fields for a specific record identified by its record ID in the path. The 'fields' query parameter is optional for this endpoint - if omitted, all rich text fields of the record are returned. When specified, only the listed rich text fields are fetched. This API...

Get email sharing details for a record. To retrieve the email sharing details for a specific record in your Zoho CRM organization, including the users whose email accounts are accessible and the available email filter options for the record's email view.

Share Records. To retrieve the share details of a specific record in a module of your Zoho CRM organization. The response lists each entry with the recipient, the access level, and the sharing metadata.

Retrieve All Attachments. Retrieves all attachments associated with a specific record in a module.

Download a specific attachment file. Download the file content of a specific attachment by its ID. This endpoint returns the actual file (image, PDF, document, etc.). Returns an error for link attachments, as they cannot be downloaded.

Get record locking information. To retrieve the locking information details of a locked record in your Zoho CRM account, including the user who locked the record, the lock source, reason, and timestamp.

Get record locking information by ID. To retrieve the locking information details of a specific locked record in your Zoho CRM account using its locking information ID, including the user who locked the record, the lock source, reason, and timestamp.

Related Records. To retrieve the list of records associated with a parent record from a specified related list in your Zoho CRM organization.

Get a related record. To retrieve the details of a specific related record from a specified related list of a parent record in your Zoho CRM organization.

Related Notes. Retrieves a paginated list of notes associated with a specific parent record in a CRM module.

Specific Related Note. Retrieves details of a specific note record associated with a CRM record in your Zoho CRM organization.

List deleted related records. To retrieve the list of records that were previously associated with a parent record but have since been deleted from the related list in your Zoho CRM organization.

List Contact Roles. Retrieves the list of contact roles available in your Zoho CRM organization.

Get a Contact Role. Retrieves the details of a specific contact role by its unique identifier in your Zoho CRM organization.

Features. To retrieve the list of all features available in your Zoho CRM organization for the current subscription edition, along with their usage limits and component details.

Specific Feature. To retrieve the detailed information for a specific feature in your Zoho CRM organization, including its usage limits, consumption details, and sub-feature components.

User Licenses Feature. To get the user licenses feature details for the current edition

Retrieve a file from ZFS. To retrieve the binary content of a file stored in Zoho File System (ZFS) using its unique file ID. The file ID is provided as a required query parameter 'id'. If the file exists, the API returns the file's binary data along with appropriate headers indicating the MIME type and content disposition for download. If the...

Get mass convert job status. To retrieve the current status and conversion counts of a previously scheduled mass convert job in your Zoho CRM organization.

Lead Conversion Options. Retrieves available conversion options for a lead including matching contacts, accounts, field mappings, and layout preferences. This endpoint helps determine what conversion paths are available before performing the actual lead conversion.

Notes. Retrieves a list of notes.

Get a Specific Note. Retrieves details of a specific note by its ID.

Get organization details. To retrieve the organization details associated with your Zoho CRM account.

List currencies. Retrieves all added currencies in the organization.

Specific Currency. Retrieves details of a specific currency via its unique currency ID.

Organization photo. To retrieve the organization photo for your Zoho CRM organization.

Get bulk read job details. To retrieve the details of a bulk read job in Zoho CRM. Use this API to check the current state of a bulk read job and obtain the download URL once the job is complete. Specify the unique job ID that Zoho CRM returned when you created the job.

Get services. To retrieve the list of service records in your Zoho CRM organization that match the specified filter criteria. Supports pagination using either the page or page_token parameter and can return up to 100,000 services across paginated requests.

Retrieve a specific service record by ID. To retrieve the full details of a single service record from your Zoho CRM organization using its unique ID, including its availability configuration, members, pricing, tax details, and subform data.

Get Appointment Preferences. Fetches the existing configuration for appointment preferences, including rules for deal creation, job sheet visibility, and mark as complete configurations.

Get audit log export jobs. To retrieve the list of all audit log export jobs in your Zoho CRM organization, along with their status, filter criteria, and download links.

Get the Status of the Export Audit Log Job. Retrieves the details of a specific audit log export job in your Zoho CRM organization by its ID, including its status, filter criteria, and download link(s).

Assignment Rules. To retrieve all Assignment Rules configured in your Zoho CRM organization.

Assignment Rules Count. To retrieve the count of Assignment Rules configured for a module in your Zoho CRM organization.

Specific Assignment Rule details. To retrieve the details of a single Assignment Rule in your Zoho CRM organization.

Assignment Rule Associations. To retrieve the CRM features associated with a single Assignment Rule in your Zoho CRM organization.

List Cadences. To retrieve the list of Cadences in your Zoho CRM organization.

Get Cadence module actions count. To retrieve the total number of follow-up actions configured for the specified CRM module across all Cadences in your Zoho CRM organization. The count includes tasks, emails, calls, and WhatsApp messages, and is used to enforce the edition-level per-module action count limit.

Get Cadence records count. To retrieve the record counts for the specified Cadences from your Zoho CRM organization. For each Cadence ID supplied in the ids query parameter, the response returns the number of records currently associated with that Cadence. A maximum of 100 Cadence IDs can be supplied per request.

Get a Cadence. To retrieve the configuration and details of a specific Cadence from your Zoho CRM organization. The response includes the follow-up action tree with server-resolved parent follow-up IDs, unenroll properties, Custom View configuration, and the current Cadence status.

Get Cadence analytics. To retrieve per-follow-up execution statistics for the specified Cadence in your Zoho CRM organization. Each follow-up element returns an analytics payload whose structure depends on its action type: tasks (open, completed, and failed counts), schedule_call (created, scheduled, completed, missed, cancelled, overdue...

Get Field Updates. Retrieves a paginated list of field update actions. OPTIONAL FILTERS: module (string — filter by module API name), related_module (string — filter by related module API name), feature_type ('workflow'), sort_by, sort_order, page, per_page. Use the Fields metadata API to get field IDs and API names, and the Modules...

Get Field Update By Id. Retrieves the details of the specified Field Update action, including its field configuration, module details, configured value, dependent fields, and audit information. Specify the Field Update ID in the path parameter. To retrieve additional field metadata, set the 'include_inner_details' query parameter to one or...

Scoring Rules. To retrieve a list of Scoring Rules configured in your Zoho CRM organization.

Get scoring rule by ID. To retrieve the details of a specific Scoring Rule by its ID in your Zoho CRM organization.

List automation task definitions with optional filters. PURPOSE: Retrieves a paginated list of automation task definitions. Supports filtering by module, feature_type, and name (via filter param). PAGINATION: page (default 1), per_page (default 200, max 200). Use info.more_records to determine if additional pages exist. A 204 response indicates no tasks match the supplied...

Automation Task. PURPOSE: Retrieves the full details of a specific automation task definition including field mappings, module association, lock status, and metadata. MANDATORY: id path parameter (string - automation task definition ID, not a Task record ID). Returns 204 if the task does not exist. Use this to inspect the current...

Get webhook execution failure records. To retrieve detailed information about webhook execution failures in your Zoho CRM organization. Optionally filter results by module, webhook ID, and date range. If the from and to parameters are not specified, the API returns webhook failures from the last 30 days by default. The maximum allowed span between from and...

Get webhooks. To retrieve the list of all webhook action configurations available in your Zoho CRM organization. The response contains summary-level data for each webhook, including the module, URL, HTTP method, feature type, and audit metadata. Use the [Get Webhooks API using...

Get webhook-associated modules. To retrieve the list of CRM modules that have at least one webhook currently associated in your Zoho CRM organization. Results are filtered based on the requesting user's module access permissions. Use these module API names as valid values for the module filter when querying webhook failures.

Get webhook action usage reports. To retrieve usage statistics for webhook actions executed in your Zoho CRM organization. Specify the group_by parameter to control the granularity of results; optionally filter by automation feature type and date range.

Get webhook by ID. To retrieve the configuration of a specific webhook in your Zoho CRM organization using its ID. Use the [Get Webhooks API](webhooks.yaml#$.paths./settings/automation/webhooks.get) first to discover webhook IDs.

List Workflow Rules in your Zoho CRM Organization. To retrieve the list of workflow rules configured in your Zoho CRM organization, including their trigger conditions, module associations, and action configurations. By default, each rule includes only summary-level data; set the include_inner_details parameter to true to include full condition criteria and action...

Get Workflow Rule Action Counts. To retrieve the total number of actions configured in the specified workflow rules in your Zoho CRM organization, including counts categorized by action type across both instant and scheduled actions.

Get Active and Total Workflow Rule Counts by Module. To retrieve the count of active and total workflow rules configured for each module in your Zoho CRM organization.

Get Workflow Rule Quota and Usage Counts. To retrieve the organization-level quota and current usage counts for workflow rules and actions in your Zoho CRM organization. The response includes the total and active rule limits (both organization-wide and per module), the number of rules currently configured, and the per-rule limits for actions and scheduled...

Retrieve Workflow Rule by ID. To retrieve the complete configuration of a specific workflow rule in your Zoho CRM organization, including its trigger type, execution criteria, conditions, instant actions, scheduled actions, and lock status. Use the [Get All Workflow Rules](workflow_rules.yaml#$.paths./settings/automation/workflow_rules.get)...

Retrieve Action Usage for a Workflow Rule. To retrieve the action usage report for a specific workflow rule in your Zoho CRM organization, including trigger count and per-action success, failure, and queue metrics, as well as email engagement statistics. Results are scoped to a configurable date range.

Business Hours Configuration. Retrieves the current business hours configuration, including working days, operating hours, and timezone details.

Get shift hours. Retrieves every shift hour configured for the organization, along with the timing, break hours, holidays, time zone, and assigned users of each shift, and an aggregate count of shifts that have at least one user assigned.

Get a shift hour. Retrieves the configuration of the shift hour identified by the shift path parameter, including its timing, break hours, holidays, time zone, and the users assigned to it.

Call Preferences. To retrieve the current Call Preferences configuration for your Zoho CRM organization. The response reports whether the From Number and To Number fields are currently enabled on records in the Calls module.

Get All Custom Views. To retrieve the list of all Custom Views configured for a specified module in your Zoho CRM organization.

Get Custom View By Id. To retrieve the details of a specific Custom View for a module in your Zoho CRM organization, using the Custom View ID.

Data Sharing Settings. To retrieve your organization's default data-sharing permissions for modules.

Get Duplicate Check Preference. To retrieve the duplicate check preference configured for the Leads module in your Zoho CRM organization.

Email Templates. To retrieve a paginated list of email templates accessible to the authenticated user in your Zoho CRM organization. The list can be scoped to a specific CRM module using the module parameter, filtered by category (such as favorite, draft, or created_by_me), and refined using a structured filter expression. Results are...

Get from addresses. To retrieve the list of email addresses configured as sender addresses for a user in your Zoho CRM organization.

List fields metadata. To retrieve the field metadata for the specified module in your Zoho CRM account, including standard, custom, subform, and linking module fields. The response includes fields from all layouts but does not contain layout-specific configurations such as mandatory flags or picklist values.

Get field metadata by ID. To retrieve the metadata of a specific custom field in a module in your Zoho CRM account by its field ID.

Get scheduled jobs for a field. To retrieve the status of scheduled jobs for picklist field operations in your Zoho CRM account, such as replace or delete picklist option jobs.

Picklist Values for a Field. Returns the available pick list values for a specified field in a module, including display values (with translations if enabled), reference values, layout associations, and metadata. Returns 204 if the field exists but is not a pick list type. Does not support pagination.

get a picklist field option. Picklist field option GET

Get Fiscal Year Settings. To retrieve the fiscal year settings configured for your Zoho CRM organization.

Get All Global Picklists. Fetches the list of global picklists available in the organization along with their details. pick_list_values, used_in_modules, and associated_fields_count can be included in the response based on the 'include' query parameter. The response can be filtered in three ways: use the 'fields' query parameter to filter by...

Get a Single Global Picklist by ID. Fetches the global picklist for given id along with their pick_list_values. used_in_modules, and associated_fields_count can be included in the response based on the 'include' query parameter. Use the fields query parameter to filter the response by key, so that only the requested keys along with id are returned. A...

Get Field Associations. Retrieves associations of picklist values with modules, fields, and layouts for a given global picklist ID.

Get Picklist Value Associations. To the list of features like blueprints, workflows create, workflow convert, workflow task, ABM, etc in which a particular picklist value is used.

Get Replaced Picklist Values. Retrieves picklist values that are currently being replaced through a replace scheduler for the given global picklist ID.

Holidays. To retrieve the list of holidays configured in Zoho CRM. Business holidays apply to all users, while shift holidays are specific to configured shift schedules. Returns paginated results.

A specific holiday. To retrieve the complete details of a specific holiday record from Zoho CRM using its unique identifier.

Inventory templates. To retrieve a paginated list of inventory templates configured in your Zoho CRM organization, with optional filtering by module, category, and field criteria, and sorting by name or usage and modification timestamps.

Inventory Template. Retrieves a single inventory template by its ID with complete details including content and all metadata.

Get layouts metadata. To retrieve the layout configurations for a specified module in your Zoho CRM organization. Note: - The profiles array is null if the user does not have the Module Customization permission in their profile. - For the Deals module, when the pipeline feature is enabled, multiple layouts exist per pipeline, each with its...

Get layout by ID. To retrieve the details of a specific layout by its layout ID for a specified module in your Zoho CRM account. Important Notes: - The profiles array is null when the user does not have 'Module Customization' permission in their profile. - For Deals module: When the pipeline feature is enabled, multiple layouts exist...

Get field dependencies for a layout. To retrieve the list of field dependencies configured for a specific layout in your Zoho CRM organization.

Get a field dependency by ID. To retrieve the complete details of a specific field dependency from a layout in your Zoho CRM organization, including all picklist value mappings.

Generate web-tab link for a module. To generate the configured web-tab link for a specific module in your Zoho CRM organization. The moduleid path parameter must be the module's API name (e.g., Leads, Contacts, Custom_Module_1).

Retrieve modules. Retrieves the list of all modules available in the Zoho CRM account, including standard, custom, subform, and linking (MxN) modules. Supports optional filtering by status, feature_name, and include to control the scope and depth of the response. When both status and feature_name are provided, modules must satisfy both...

Get module metadata by API name. Retrieves complete metadata for a specific CRM module identified by its API name, including fields, layouts, profiles, related lists, and feature capabilities. Returns 204 when the module is not available through this endpoint, or 400 when the identifier is invalid or the module is unsupported

Pipelines. Retrieve all pipelines available for the specified Deals layout. Use the required layout_id query parameter to identify the layout.

Specific Pipeline. Retrieve a specific pipeline by pipeline ID for the specified Deals layout.

Portals. To retrieve the list of all portals configured for the Zoho CRM organization. A 204 response indicates no portal has been created yet.

Specific Portal. To retrieve the complete configuration of a specific portal in the Zoho CRM organization, including its SAML authentication settings, active status, and creation metadata.

Portal User Types. Retrieves a list of all portal user types configured for the specified portal, with their summary configuration including name, status, user counts, and last modification time.

List portal users. To retrieve the list of portal users in your Zoho CRM organization for the specified portal and user type, with optional filtering by source.

Portal User Type. Retrieves the full configuration of a single portal user type, including identity fields, active status, user counts, audit metadata, personality module, invitation field, and per-module access permissions.

Profiles. Retrieves the paginated list of all profiles in the organization, including each profile's name, type, permission details, and section groupings. Use the type query parameter to filter by profile type, and include_types to include Lite or Support profiles alongside the default set. See [Get...

Profile. Retrieves the full details of the CRM profile identified by {id}, including its complete permission tree organized by sections and categories. See [Get Profiles](https://www.zoho.com/crm/developer/docs/api/v8/get-profiles.html).

Get record locking configuration. Retrieves the existing record locking configuration for the specified module.

Get specific record locking configuration. Retrieves a specific record locking configuration using the configuration ID provided in the URL path.

Get recycle-bin records. To retrieve a paginated list of records currently present in the Recycle Bin in your Zoho CRM account. The response contains up to 200 records per page, along with pagination metadata. The list can be filtered by display name, source module, the user who deleted the records, or the deletion timestamp. Sorting is...

Get recycle-bin record count. To retrieve the total count of records currently present in the Recycle Bin in your Zoho CRM account. The count reflects every entry across all modules.

Get a recycle-bin record. To retrieve metadata for a single record from the Recycle Bin in your Zoho CRM account using its unique ID. The response includes the display name, source module, deletion timestamp, original owner, and the user who deleted the record.

Related Lists. To retrieve the configuration of related list panels for a specific module in your Zoho CRM organization, including display metadata, available record operations, and layout-specific settings.

Get all roles. Returns the list of all roles configured in your Zoho CRM organization.

Get a role. Returns the details of a single role, specified by its ID in the URL.

Get service preferences. Retrieves the service preference settings of the organization, including whether the job sheet is enabled for service appointments. Use this API to check whether a job sheet can be generated once a service appointment is marked complete.

Tags. To retrieve all tags associated with a module in your Zoho CRM organization.

Mass Delete Tags Status. To retrieve the current status, the scheduled time, and the success and failure counts for a previously scheduled mass delete tag job in your Zoho CRM organization, using the job ID returned by the Mass Delete Tags POST operation.

Get Tag Records Count. Retrieves the number of records associated with a specific tag, including workflow, blueprint, and orchestration usage details.

Get all territories. To retrieve the list of territories enabled for your Zoho CRM organization.

Get territory-associated user counts. To retrieve the number of users associated with each territory in your Zoho CRM organization.

Get scheduled territory run rule job status. To retrieve the status of a scheduled territory rule execution job in your Zoho CRM organization by specifying the job_id parameter.

Get territory by ID. To retrieve the details of a specific territory in your Zoho CRM organization using its unique ID.

Get child territories by parent territory ID. To retrieve the list of child territories for a specific parent territory in your Zoho CRM organization. Use the ID path parameter to specify the parent territory, and optional query parameters such as filters, include, include_inner_details, page, and per_page to narrow results and control pagination.

Territory Users. To retrieve the list of users associated with a territory in your Zoho CRM organization.

Specific Territory User. To retrieve the details of a specific user associated with a territory in your Zoho CRM organization.

Get Unsubscribe Link Associations. To retrieve information about where unsubscribe links are being used (associated places) in your CRM account, such as in email templates.

Get Unsubscribe Links. To retrieve the details of all unsubscribe links configured in your CRM account. This API returns a list of unsubscribe links with their complete configuration, including page type, submission behavior, timestamps, and creator information.

Get Unsubscribe Link by ID. To retrieve the complete configuration details of a specific unsubscribe link using its ID. This includes page settings, submission behavior, timestamps, and creator information.

Get user groups. To retrieve a paginated list of user groups configured in your Zoho CRM organization, with optional filtering by name or criteria, and optional inclusion of member source counts.

Get associated users count per user group. To retrieve the count of users associated with user groups in your Zoho CRM organization, optionally filtered by group criteria.

Get a user group. To retrieve the details of a specific user group in your Zoho CRM organization by its unique ID, with optional inclusion of member source counts.

Get associations for a user group. To retrieve the list of CRM resources, such as sharing rules, workflows, assignment rules, and approval processes, that are associated with a specific user group in your Zoho CRM organization.

Get source counts for a user group. To retrieve the count of member sources by type (users, roles, territories, and groups) for a specific user group in your Zoho CRM organization.

Get sources for a user group. To retrieve the paginated list of member sources configured for a specific user group in your Zoho CRM organization.

Variable Groups. To retrieve a list of all variable groups in your Zoho CRM organization.

Get variable group by ID. To retrieve the details of a specific variable group by its ID in your Zoho CRM organization.

Retrieve all variables. Retrieves all available CRM variables. Returns the API name, display name, description, type, value, and variable group for each variable. Requires the ZohoCRM.settings.variables.READ scope.

specific variable. Retrieves the details of a specific CRM variable by its ID. The group query parameter, specifying the variable group ID or API name, is mandatory when retrieving a specific variable. Requires the ZohoCRM.settings.variables.READ scope.

Variable Associations. Get associated variables

Get all wizard configurations. To retrieve the wizard configurations available in your Zoho CRM organization. The response can be filtered by module using the module query parameter. When you set up conditional rules for a wizard, the response contains the keys execute_on and type. execute_on represents when the conditional rule is executed. The...

Get wizard details. To retrieve the complete configuration of a single wizard in your Zoho CRM organization, including its containers, screens, segments, buttons, and conditional rules.

Data Enrichment. Use this API to get the details of configuration for data enrichment. This API gives you the mapping of the enrich fields with their corresponding CRM fields for enriching data. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs and API names for filtering or reference.

Get Zia Enrichment Configuration for a specific module. Retrieves a specific Zia Enrichment Configuration by ID. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to get CRM field IDs and API names, and the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs and API names for reference.

Get users. To retrieve all users in your Zoho CRM organization based on the specified filter parameters, including type, role, query criteria, and field selection.

Get user transfer status. Retrieves the current status of a user transfer operation using the job ID returned by the transfer request. The response indicates whether the transfer job is scheduled, in progress, completed, or failed.

Get transfer and delete status. Retrieves the current status of a transfer and delete operation using the job ID returned by the POST request. The response indicates whether the job is scheduled, in progress, completed, or failed.

Get a specific user. To retrieve the details of a specific user in Zoho CRM, use the unique user ID as the path parameter.

Get associated groups for a user. To retrieve the paginated list of user groups associated with a specific user in your Zoho CRM organization, with optional inclusion of member sources and source counts.

Get territories of a user. To retrieve all territories assigned to a specific user in your Zoho CRM organization.

Specific territory of a user. To retrieve a specific territory assigned to a user in your Zoho CRM organization.

Validate user before transfer. Validates whether the specified user has open records, assignments, criteria configurations, subordinates, or alerts before transferring the user's data. Use this operation to check the user's dependencies before initiating a transfer.

Workflow Configuration. Retrieves the available triggers, actions, and related trigger details for a specific module. Use this endpoint before creating or updating workflow rules to discover which triggers and actions are supported, their per-type limits, scheduling compatibility, and related module triggers. The response includes three...

Get bulk write job details. To retrieve the details of a previously created bulk write job in your Zoho CRM organization, including its current status, per-resource and per-file processing counts, the creator, and the download URL of the result archive once the job completes. The download URL remains accessible for up to seven days after the job...

Get Zia Org Enrichment. To retrieve the paginated list of Zia organization enrichment jobs that have been scheduled in your Zoho CRM organization. Each entry includes the job identifier, current status, creation timestamp, and the user who triggered the job.

Org Enrichment Details. Fetches the enrichment status and enriched organization data for a specific enrichment job using its unique ID. Returns completed, scheduled, or failed enrichment information along with enriched fields such as name, website, email, address, CEO, revenue, employees, social media, and industries.

Update notification channel information. To partially update the properties of a notification channel in your Zoho CRM organization.

Update custom fields. To update one or more custom fields in a module in your Zoho CRM account.

Update a custom field. To update a specific custom field in a module in your Zoho CRM account by its unique field ID.

Update a Global Picklist. Updates an existing global picklist. You can update display_label, api_name, description, pick_list_values_sorted_lexically, and pick_list_values. Backend-generated properties (actual_label, customizable, modified_by, created_by, presence) cannot be updated. For pick_list_values, you can add new values, update...

Update a Global Picklist by ID. Updates an existing global picklist identified by the path parameter {id }. You can update display_label, api_name, description, pick_list_values_sorted_lexically, and pick_list_values. Backend-generated properties (actual_label, customizable, modified_by, created_by, presence) cannot be updated. For...

Update a custom layout. To update a custom layout in your Zoho CRM organization, including renaming it, modifying profile permissions, enabling or disabling the business card display, and creating, updating, or deleting sections and fields within sections.

Pipeline. Update or delete a pipeline for the specified layout using a request body that identifies the pipeline and its stage mappings.

Pipeline. Update or delete a specific pipeline identified by the path ID within the specified layout.

Profile. Partially updates the name, description, and permission enablement for the profile identified by {id}. System profiles (Administrator, Standard) cannot be updated. See [Update Profile Permission](https://www.zoho.com/crm/developer/docs/api/v8/update-profile-permission.html).

Create notification channels. To create one or more notification channels in your Zoho CRM organization.

Create Appointment records. To create one or more appointment records in your Zoho CRM organization.

Create records in a specified module. Creates one or more records in the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API name. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the available field API names and data types....

Add Tags to Records. Associates tags to one or more records in the specified module.

Assign territories to multiple records. To assign one or more territories to multiple records in your Zoho CRM organization.

Change Owner. Updates the owner of multiple records in the module. Note: The module name Deals is accepted and internally resolved to Potentials. Meetings is internally resolved to Events.

Enroll Records to Cadences. Enrolls CRM records into one or more cadences. Notes - Only Manual Enrollment cadences can be enrolled through this API. - Available only in Enterprise edition and above. - Supports Leads, Contacts, Deals, Vendors, and custom modules. - A request may contain up to 5 cadence IDs. - A request may contain up to 100...

Submit mass change owner job. To bulk update the ownership of records in a specified module based on a Custom View, territory, or field-based criteria in your Zoho CRM organization. You cannot change the owner of related records using this API. You can change the owner of up to 50,000 records in a custom view. This API schedules the operation as a...

Delete records in bulk by record IDs or Custom View. To delete records in bulk from a specified module in your Zoho CRM organization, either by providing record IDs for synchronous deletion or a Custom View ID for asynchronous batch deletion.

Mass update records. To update a specific field value across multiple records of a module in your Zoho CRM organization in a single API call. The operation supports two modes. In the non-scheduler mode, the caller supplies a list of record IDs in the ids array and the system updates those records synchronously, with a maximum of 500...

Invite portal users. To send portal invitations in bulk to CRM records in your Zoho CRM organization for the specified module, scheduling them as asynchronous invitation jobs.

Remove Tags from Records. Removes tags from one or more records in the specified module.

Remove territories from multiple records. To remove one or more territories from multiple records in your Zoho CRM organization. Supported modules are Leads, Accounts, Contacts, and Deals. The removal can be processed synchronously or scheduled as a background job, depending on the number of records.

Unblock emails for multiple records in a module. To unblock soft-bounced email addresses for multiple records in your Zoho CRM organization. When emails sent from CRM bounce temporarily, the Email field on the affected records is blocked. This operation removes those blocks in bulk so email communication with the records can resume.

Un-enroll Records from Cadences. To manually unenroll records of a supported module from one or more Cadences in your Zoho CRM organization.

Bulk Search Records by Criteria, Word, Email, or Phone. Searches for records in the specified module that match the given search criteria. This API accepts the same search parameters as the GET /{module}/search API, but they are provided in the request body instead of query parameters. Use this API when the search criteria are too long to be passed as query parameters. You...

Add Tags to a Record. Adds tags to a specific record in the specified module.

Remove Tags from a Record. Removes tags from a specific record in the specified module.

Unblock email for a single record. To unblock a soft-bounced email address for a single record in your Zoho CRM organization. When an email sent from CRM bounces temporarily, the Email field on the affected record is blocked. This operation removes that block so email communication with the record can resume.

Merge Records. To merge duplicate records in your Zoho CRM organization into a single master record. Supports field-level value selection from child records and file attachment management. If a child record has more than 1000 related records, the merge processes asynchronously and returns a job_id for status tracking.

Assign territories to a record. To assign one or more territories to a single record in your Zoho CRM organization.

Change Owner. To change the owner of a specific record in the specified CRM module in your Zoho CRM organization. Note: The module name Deals is accepted and internally resolved to Potentials. Meetings is internally resolved to Events.

Remove territories from a record. To remove one or more territories from a single record in your Zoho CRM organization. This operation is supported for records in the Leads, Accounts, Contacts, and Deals modules.

Create Email Drafts for a Record. Creates one or more email drafts associated with the specified record in the given module.

Associate Email. Associates an email with a specific record in a module, creating a link between the email and the CRM record.

Record Clone. Clones a record in the specified module. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and API names. By default, the field values of the parent record...

Invite portal users. To send a portal invitation to a single CRM record in your Zoho CRM organization, inviting or re-inviting the record as a portal user for the specified user type.

Create or update records in a specified module. The Upsert API inserts a new record or updates an existing record based on duplicate check field values. If a matching record is found, it is updated; otherwise, a new record is inserted. When using the Upsert API, the system checks for duplicate records based on the duplicate check fields. There are two types of...

Share Record Emails. To share email threads linked to multiple CRM records with colleagues in the same organization. Accepts up to 100 record IDs per request. Supports partial success - each record in the response is processed independently, and individual results indicate success or failure.

Unshare emails in bulk. To revoke email sharing for multiple CRM records in a single request. Accepts up to 100 record IDs per request. The data array in the 207 response contains an item for each record, indicating success or failure.

Convert Inventory Record. To convert an inventory record in your Zoho CRM organization from one module to another. Supported conversion paths are: Quotes to Sales Orders or Invoices, and Sales Orders to Invoices.

Share Record Emails. To share email threads linked to a specific CRM record with colleagues in the same organization. Requires custom email sharing to be enabled in the organization and a valid email configuration for the user.

Unshare Record Emails. To revoke email sharing for a specific CRM record, making the linked email threads no longer visible to colleagues. Requires custom email sharing to be enabled in the organization and a valid email configuration for the user.

Download mail merge document. To download the merged document created from a mail merge template for a specific record in your Zoho CRM organization. You can choose the output format as pdf, html, or docx, and optionally set a password for PDF documents.

Get related records count. To retrieve the count of related records for a specified parent record in your Zoho CRM organization. Supports optional filtering by approval status, conversion status, category type, and field-level equality criteria. A single request can include up to 20 related list count specifications. You can use this API to get...

Send mail merge email. To send a personalized email to one or more recipients using a mail merge template associated with a specific record in your Zoho CRM organization. You can include recipients in the To, CC, and BCC fields, and optionally attach the merged document either as an inline image or a separate file.

Share a record. To share a specific record in a module with one or more users, roles, or groups. A record can be shared with up to 10 users, 5 roles, and 5 groups. > Note: > - The records can be shared to other users in the organization only if certain conditions are met. For simplicity, let us assume that User A shares a record with...

Send mail merge document for signing. To send a merged document to one or more recipients for signing or approval using a mail merge template associated with a specific record in your Zoho CRM organization. Before using this operation for the first time, you must access the Merge and Sign dialog in the Zoho Writer UI once.

Send an email to a record. To send an email to a specific record in your Zoho CRM organization using a template or custom email content.

Lock a record. To lock a record in the specified module of your Zoho CRM account with a reason for locking.

Related Notes. Creates one or more notes associated with a specific parent record. Either note content or note title must be provided (at least one is mandatory).

Process multiple API requests in a single call. To bundle multiple Zoho CRM API requests into a single HTTP call, reducing network round-trips and enabling request chaining. You can reference the output of one sub-request in another using the format @{sub_request_id:JSONPath} to build dependent workflows. When rollback_on_fail is enabled, all successful...

Link Emails to Deals. To link a deal with one or more of a contact's emails. An email can only be linked to a single deal at a time. Zoho CRM automatically links a contact's incoming emails to the deals using the [Deal Prediction...

Link Deal Email. Links an email to a specified record in CRM.

Create Contact Roles. Creates one or more contact roles in your Zoho CRM organization.

Retrieve records using a COQL query. To retrieve records from one or more Zoho CRM modules using a COQL SELECT query, with support for cross-module joins, aggregate functions, and flexible filtering.

Cancel a Meeting. To cancel a meeting and send an email regarding the meeting cancellation to the participants. A meeting can only be cancelled if attendees have already been invited and the meeting has not passed its scheduled end time. To check the cancellation status of a meeting, refer to the $event_cancelled key in the response...

Submit mass convert job for leads. To submit a mass convert job that converts lead records into Contacts, Accounts, or Deals in your Zoho CRM organization. The job runs asynchronously and returns a job identifier for status tracking.

Convert a Lead. Converts a Lead record into Contact, Account, and/or Deal records. Allows configuration of conversion behavior including overwrite settings, notifications, owner assignment, and tag carryover.

Create Notes. Creates one or more note records.

Create currencies. Creates one or more new currencies for the organization.

Enable multi-currency

Create a bulk read job. To create a bulk read job in Zoho CRM. A bulk read job exports records from a specified CRM module to a CSV or ICS file. The job runs asynchronously; use the Get Bulk Read Job Details API to monitor the job status, and use the Download Bulk Read Result API to retrieve the exported file once the job is complete.

Create service records in Zoho CRM. To create one or more service records in your Zoho CRM organization, submitting up to 100 service objects per request, each configurable with a name, duration, price, location, members, availability type, and availability window.

Create an audit log export job. To create an asynchronous audit log export job in your Zoho CRM organization. The system schedules the job and returns a unique job ID with a SCHEDULED status code. Use the[Get Audit Log Export API](audit_log_export.yaml#.$./paths./settings/audit_log_export.get) to poll for completion and retrieve the download links.

Create an Assignment Rule. To create a single Assignment Rule in your Zoho CRM organization.

Clone Assignment Rule. To clone a single Assignment Rule in your Zoho CRM organization.

Create cadence. Creates a new cadence (initially in draft status) with its follow-up tree and optional un-enrollment rules in a single call. custom_view cadences require a custom_view.id; manual_enrollment cadences must omit custom_view. Follow-ups reference each other via reference_id (a client-chosen string) so that parent/child...

Activate Cadence. Activates a published cadence so it begins enrolling records. The cadence must currently be inactive; otherwise, the ALREADY_ACTIVATED error is returned. Edition limits are enforced, including the maximum number of active cadences per module and the total number of active cadences. For custom_view cadences, activation...

Clone a Cadence. Creates a new cadence with the same follow-up tree as the source cadence (identified by path id) but with the name / description / custom_view supplied in the body. Every follow-up action is copied into a new action record - the clone has no shared rows with the source. The new cadence starts in draft status and must...

Deactivate a Cadence. To deactivate a Cadence in your Zoho CRM organization. The Cadence must currently be active; attempting to deactivate an already inactive Cadence returns the ALREADY_DEACTIVATED error.

Publish a Cadence. Publishes a draft cadence by merging its follow-up tree, transitions, and triggers into the live cadence, and then clears the draft. If the cadence is being published for the first time, it is promoted from a draft to an inactive published cadence. Call the Activate Cadence API separately to begin enrolling records....

Create Field Update. Creates a field update action that assigns a static value to a field, triggered by a workflow rule. For single-value fields, use a string for value. For multi-select and multi-user field types, use an array for value (for example, ['Call', 'Advertisement']). update_type (mandatory for multi-select and multi-user...

Scoring Rules. Creates one or more scoring rules for specified modules and layouts. Only Leads and Contacts modules support signal rules. Deals, Accounts and Custom Modules do not support signal rules.

Clone a scoring rule. To clone a Scoring Rule in your Zoho CRM organization.

Create an Automation Task. PURPOSE: Creates an automation task definition used by workflow rules, approval processes, blueprints, kiosks, scoring rules, and case escalation rules. PREREQUISITES: (1) Call GET /settings/automation/tasks to check existing task definitions and avoid duplicates. (2) Call GET /settings/layouts?module=Tasks to...

Webhooks. To create a webhook action that fires an HTTP request to an external URL in your Zoho CRM organization when an automation trigger fires. The http_method value controls which optional request fields are accepted. - POST and PUT accept headers and body - GET and DELETE methods accept url_parameters - DELETE also accepts...

Create a workflow rule for a module. To create a workflow rule for a specified module in your Zoho CRM organization. Each request accepts exactly one rule, defined within the workflow_rules array.

Business Hours Configuration. Creates a new business hours configuration for the organization, defining working days, operating hours, and timezone settings.

Add shift hours. Creates one or more shift hour configurations for the organization. Each shift hour specifies the name, time zone, active days, timing, optional break windows, optional holidays, and optional user assignments. The shift hour timing must fall within the configured business hours, and the request is rejected if business...

CustomView creation. To create one or more Custom Views for a specified module in your Zoho CRM organization.

Create Duplicate Check Preference. To enable duplicate check preference for the Leads module in your Zoho CRM organization.

Create custom fields in a module. To create custom fields in a module in your Zoho CRM organization, where supported modules include Leads, Contacts, Accounts, Campaigns, Cases, Invoices, Deals, Price Books, Products, Purchase Orders, Quotes, Sales Orders, Solutions, Vendors, Calls, Tasks, Events, Users, and Custom modules.

Replace Pick list values. Replace picklist value

Create a Global Picklist. Creates a new global picklist with the specified display label, API name, description, and picklist values. The actual_label, customizable, modified_by, created_by, and presence properties are generated by the backend. In pick_list_values, only display_value and type are considered.

Replace Picklist Values. Schedules or executes replacement of picklist values for the specified global picklist. You can specify either id, display_value, or both for old_value and new_value. If both are provided, the system validates them for consistency. The from (old) value can be non-existent in the current picklist, but the to (new)...

Holidays. To create one or more business or shift holidays in Zoho CRM. Business holidays apply to all users, while shift holidays must specify a valid shift_hour identifier.

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

Create a field dependency for a layout. To create a field dependency between a parent picklist field and a child picklist field for a specific layout in your Zoho CRM organization. Prerequisites - The selected layout must contain at least two option-based fields. - Supported field types are Picklist, Radio Button, and Multi-select Picklist. - Multi-select...

Create a custom module. To create a custom module in your Zoho CRM organization. Only one module can be created per request. The required permission depends on the access type: Crm_Implied_Customize_Zoho_CRM for org-based modules and Crm_Implied_Create_Team_Module for team-based modules. Submitting the same api_name multiple times will...

Pipeline. Create a new pipeline for the specified Deals layout by providing a pipeline display label and one or more mapped stages.

Transfer Pipeline. Transfer records and stage mappings from one pipeline to another in the specified layout, and delete the source pipeline after the transfer is scheduled.

Portal. To create a Client Portal for the Zoho CRM organization. Only one portal can be created per organization. The portal name must be unique across Zoho, between 6 and 30 characters.

Portal User Type. Creates a new portal user type for the specified portal. A portal user type defines the personality module, invitation field, and per-module access permissions for portal users. The portal must already exist in the organization's Zoho CRM account.

Transfer portal users from one user group to another. To transfer one or more portal users from one user type group to another within the same portal in your Zoho CRM organization.

Clone a CRM profile. Creates a new profile by cloning the existing profile identified by {id}. The request body must include the new profile's name, which must be unique within the organization and must not exceed 50 characters. See [Create a Profile](https://www.zoho.com/crm/developer/docs/api/v8/create-profile.html).

Create record locking configuration. Creates a new record locking configuration for the specified module. You can define locking rules, restricted actions, excluded fields, and other settings.

Empty the Recycle Bin. To permanently delete every record from the Recycle Bin in your Zoho CRM account. This action is irreversible - the records cannot be restored after this operation completes. When the Recycle Bin contains 1000 or fewer records, including child records such as Notes and Attachments, Zoho CRM deletes the records...

Restore multiple Recycle Bin records. To restore one or more deleted records from the Recycle Bin in your Zoho CRM account. Supply the scope of restoration in the request body using exactly one of three options: ids to restore specific records, filters to restore records matching field-based criteria, or restore_all_records to restore every record...

Restore a Recycle Bin record. To restore a single deleted record from the Recycle Bin in your Zoho CRM account. The record is moved back to its original module along with all its associated child records, such as Notes and Attachments. When the total number of restored records, including child records, is 1000 or fewer, the restoration completes...

Create a role. Creates a new role in your Zoho CRM organization.

Tags. To create tags for a module in your Zoho CRM organization.

Mass delete tags. To schedule a background job that deletes multiple tags in bulk from a single module in your Zoho CRM organization. You can delete tags in bulk from one module per API call. The response returns a job identifier that can be used with the Mass Delete Tags Status GET operation to track the progress of the deletion.

Merge Tags. Merges two tags into one, combining their associated records and metadata. The tag specified in the path parameter (id) is the master tag that will remain after the merge. The conflict_id in the request body specifies the tag to be merged into the master tag.

Create Territories. To create one or more territories in your Zoho CRM organization.

Run territory assignment rules. To schedule territory assignment rules to run against records in a specified module in your Zoho CRM organization. The rules can be applied based on filter criteria, a Custom View, or specific territories, and the execution is queued as a background job.

Transfer and delete territories. To transfer records from one or more territories to a target territory and then delete those territories in your Zoho CRM organization.

Transfer and delete a specific territory by ID. To transfer child territories to a target parent territory and then delete a specific territory from your Zoho CRM organization. This operation is required for territories that have child territories, as they cannot be directly deleted using the Delete Territories API.

Create Unsubscribe Link. To create an unsubscribe link that can be used in email templates or email footers. You can configure the link to display a standard Zoho CRM unsubscribe page or redirect to a custom webpage.

Create a user group. To create a new user group in your Zoho CRM organization with a specified name, optional description, and member sources (users, roles, or territories).

Generate API Name. To generate an available API name for a new variable group in your Zoho CRM organization. Submit the proposed display name in the request, and the API returns a suggested api_name that complies with the naming requirements.

Create variables. Creates one or more CRM variables. The name, api_name, and variable_group keys are mandatory. The type key specifies the data type of the variable. Possible types: integer, text, percent, decimal, currency, date, datetime, email, phone, url, checkbox, textarea, long. Requires the ZohoCRM.settings.variables.CREATE...

Generate API Name. generates api name

Zia Data Enrichment Configuration. Creates Zia Enrichment Configurations for a specific module. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to get CRM field IDs and API names, and the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs and API names.

Create User. To create a new user record in your Zoho CRM organization. The request body must contain a users array with one user object including the required fields such as email, role, profile, and first name.

Transfer and delete a user. Transfer user records, assignments, and criteria to another user

Transfer a user. Transfer user records, assignments, and criteria to another user

Transfer and delete a user. Transfer user records, assignments, and criteria to another user

Create a bulk write job. To create a bulk write job in your Zoho CRM organization that creates, updates, or upserts records in a target module from a previously uploaded file. The job is processed asynchronously; the response returns the job identifier that the get job details operation uses to poll job status, and an optional callback URL is...

Trigger organization-level enrichment for a CRM record. To submit a request that schedules a Zia organization enrichment job in your Zoho CRM organization. The job runs asynchronously and uses the supplied name, email, or website to retrieve publicly available details such as address, primary contact, industries, and social media handles, and to populate the configured...

Update full notification details. To replace all properties of an existing notification channel in your Zoho CRM organization.

Update appointment records. To update one or more appointment records in your Zoho CRM organization. You can update a maximum of 100 appointments per API call.

Update an Appointment Record by ID. To update a single appointment record by its ID in your Zoho CRM organization.

Update records in a specified module. Updates one or more existing records in the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module API name and the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field API names. A maximum of 100...

Deal Contact Roles. Add contact roles to a deal or update existing contact role relations in bulk.

Deal Contact Roles. Assign or update a contact role for a specific contact on a deal.

Update Email Drafts for a Record. Updates one or more email drafts associated with the specified record in the given module.

Update an Email Draft. Updates the specified email draft for the given record in the module.

Update a specific record by ID. To update the field values of a specific record in the specified module in your Zoho CRM organization. Use the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module ID and API name. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and...

Update share permissions. To update the sharing permissions of a specific record in a module of your Zoho CRM organization. The update can change the access level, change the visibility between private and public, or alter whether related records are shared along with the record.

Update locking reason of a locked record. To update the locking reason of a locked record in the specified module of your Zoho CRM account.

Update related records. To update multiple records associated with a parent record in a specified related list in your Zoho CRM organization.

Update a related record. To update the properties of a specific record associated with a parent record in your Zoho CRM organization.

Related Notes. Updates one or more notes associated with a specific CRM record in your Zoho CRM organization. Either note content or note title must be provided (at least one is mandatory) for each note.

Related Note. Updates an existing note associated with a specific parent record. Either note content or note title must be provided (at least one is mandatory).

Update Contact Roles. Updates the properties of one or more existing contact roles in your Zoho CRM organization.

Update a Contact Role. Updates a specific contact role by its unique identifier in your Zoho CRM organization.

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

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

Update currencies. Updates one or more currencies other than the base currency.

Update base currency. Update existing base currency details.

Currency. Update a specific currency by its unique ID.

Update service records. To update one or more existing service records in your Zoho CRM organization. Each request can include up to 100 service objects identified by their record IDs; only the fields supplied in the payload are modified.

Update a specific service record by ID. To update a single service record in your Zoho CRM organization, identified by its unique ID. Only the fields supplied in the request payload are modified on the targeted service.

Update Appointment Preferences. To update the appointment preference settings in your Zoho CRM organization, including booking constraints, job sheet requirements, deal creation configuration, and record-sharing settings.

Update a Specific Assignment Rule. To update a single Assignment Rule in your Zoho CRM organization.

Clone Assignment Rule Entries. To clone rule entries for a single Assignment Rule in your Zoho CRM organization.

Reorder Assignment Rule entries. To reorder rule entries for a single Assignment Rule in your Zoho CRM organization.

Update multiple Cadences (bulk form). Partial-update form that takes the cadence id inside the request body (cadences[0].id). Updates only the provided fields; module / type / custom_view cannot be changed after creation. Editing a currently-published cadence creates a draft on the first save. Follow-up add/update is expressed inline via the follow_ups...

Cadence. Partial-update form that takes the cadence id from the URL path. Same body shape and semantics as the bulk PUT variant (see PUT /settings/automation/cadences). module / type / custom_view cannot be changed after creation.

Update Field Update. Updates an existing field update action identified by the path ID. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) to find the field update ID. Locked actions require the appropriate privilege, and read-only actions cannot be modified. For single-value fields, use a...

Scoring Rules. Updates one or more scoring rules. Returns 200 (all success) or 207 (partial success).

Update a scoring rules by ID. To update a specific Scoring Rule by its ID in your Zoho CRM organization.

Activate a scoring rule. Activates an inactive scoring rule identified by ruleId, enabling it to start evaluating and scoring CRM records based on its configured criteria.

Update an automation task definition by ID (full replacement). PURPOSE: Updates an existing automation task definition identified by the path parameter ID. PREREQUISITES: (1) Call GET /settings/automation/tasks/{id} to obtain the current task structure. (2) Call GET /settings/layouts?module=Tasks to verify supported fields and identify mandatory fields where required: true in the...

Automation Task. PURPOSE: Updates an existing automation task definition identified by the path parameter ID. PREREQUISITES: (1) Call GET /settings/automation/tasks/{id} to obtain the current task structure. (2) Call GET /settings/layouts?module=Tasks to verify supported fields and identify mandatory fields where required: true in the...

Update webhooks. To update the configuration of an existing webhook in your Zoho CRM organization. The module field cannot be changed after creation. The request body must contain a webhooks array with exactly one webhook object. To retrieve valid module API names, refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get)...

Update webhook by ID. To update the configuration of a specific webhook in your Zoho CRM organization using its ID. The module field cannot be changed after webhook creation. Read-only webhooks created by Marketplace extensions cannot be updated.

Update workflow rules by ID in the request body. To update one or more existing workflow rules in your Zoho CRM organization, submit a workflow_rules array in the request body with each entry containing the rule's id. You can modify a rule's name, description, criteria, conditions, actions, and active status. Triggers may be updated only within the same trigger type...

Update Workflow Rule Execution Order for Module. To update the execution order of workflow rules for a specific module in your Zoho CRM organization. By default, rules execute in the order in which they were created. If any of the specified rule IDs are invalid, the entire request fails and no partial updates are applied.

Update Workflow Rule by ID. To update an existing workflow rule in your Zoho CRM organization, use this operation with the rule's unique ID. You can modify the rule's name, description, triggers, criteria, conditions, and actions, or activate and deactivate the rule. Use the [Get Workflow Rules...

Business Hours Configuration. Updates the existing business hours configuration with revised working days, operating hours, or timezone settings.

Update shift hours. Updates one or more shift hour configurations for the organization. Each entry in shift_hours identifies the shift hour to update and the fields to change, such as the time zone, active days, timing, break windows, holidays, or user assignments. The updated timing must fall within the configured business hours.

Update a shift hour. Updates the configuration of the shift hour identified by the shift path parameter. The request body specifies the fields to change, such as the time zone, active days, timing, break windows, holidays, or user assignments. The updated timing must fall within the configured business hours.

Call Preferences. To update the Call Preferences configuration for your Zoho CRM organization by enabling or disabling the From Number and To Number fields on records in the Calls module. A preference cannot be disabled when the corresponding field is marked as mandatory, when it is referenced by a Validation Rule, Layout Rule...

Custom Views. To update the configuration of one or more Custom Views in bulk for a specified module in your Zoho CRM organization.

Sort Order. To change the sort field and sort order for one or more Custom Views in the specified module of your Zoho CRM organization.

CustomView update. To update the configuration of a specific Custom View in a module of your Zoho CRM organization, using the Custom View ID. Use the [Get Custom Views API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the custom view IDs.

Sort Order by ID. To change the sort field and sort order for a specific Custom View in the specified module of your Zoho CRM organization. Use the [Get Custom Views Metadata API](custom_views.yaml#$.paths./settings/custom_views.get) to retrieve the custom view IDs.'

Data Sharing Settings. To update your organization's default data-sharing permissions for modules. You can modify data-sharing access for both system-defined and custom modules.

Update Duplicate Check Preference

Update Fiscal Year Settings. Updates the fiscal year configuration for the organization. Only administrators can update fiscal year settings.

Multiple Holidays. To update one or more existing holiday records in Zoho CRM by providing each holiday ID with the updated field values.

A specific holiday. To update the name or date of a specific holiday record in Zoho CRM using its unique identifier.

Update an existing field dependency. Updates the picklist value mappings for an existing field dependency. Use '_delete ': null to remove specific mappings.

Update CRM modules. Updates existing modules in the CRM. Allows modification of module labels (singular_label, plural_label) and profile assignments. Supports batch updates of up to 100 modules per request. Returns 200 when all modules update successfully, or 207 Multi-Status when some succeed and others fail. Module access_type cannot...

Update Module Labels and Profiles. Updates the singular label, plural label, and profile assignments for the module identified by {moduleIdentifier}. Immutable fields such as access_type and api_name cannot be changed; attempting to include them returns a NOT_ALLOWED error

Pipeline. Update, or delete a pipeline for the specified layout using the supplied pipeline configuration in the request body.

Pipeline. Update or replace a specific pipeline identified by the path ID for the specified layout.

Portal. To update the configuration of an existing portal in the Zoho CRM organization, including the portal name and SAML single sign-on settings.

Portal User Status. To activate or deactivate multiple portal users in bulk in your Zoho CRM organization for the specified portal and user type.

Change status of portal users. Changing portal users status.

Portal User Type. Updates the configuration of an existing portal user type. You can modify module-level access settings, including shared type, allowed layouts, filter fields, and field-level permissions.

Specific Profile. Replaces the name, description, and permission enablement for the profile identified by {id}. System profiles (Administrator, Standard) cannot be updated. See [Update Profile Permission](https://www.zoho.com/crm/developer/docs/api/v8/update-profile-permission.html).

Update record locking configuration. Updates an existing record locking configuration for the specified module. You can modify any of the configuration settings.

Update specific record locking configuration. Updates an existing record locking configuration for the specified module using the configuration ID provided in the URL path.

Update a role. Updates an existing role in your Zoho CRM organization.

Update a role. Updates a single role, specified by its ID in the URL.

Update service preferences. Updates the service preference settings of the organization. Use this API to enable or disable the job sheet, which controls whether a job sheet can be generated for a service appointment once the appointment is marked complete.

Tags. To update an existing tag in your Zoho CRM organization.

Update tag by ID. To update the details of a specific tag by its ID in your Zoho CRM organization.

Update territories. To update the details of one or more territories in your Zoho CRM organization.

Update a specific territory by its ID. To update the details of a specific territory by its unique ID in your Zoho CRM organization.

Territory Users. To associate one or more users with a territory in your Zoho CRM organization.

Territory User. To associate a specific user with a territory in your Zoho CRM organization.

Update Unsubscribe Links. To update one or more unsubscribe links in bulk. You can modify the link's name, page type, custom URL, standard page message, submission action type, redirect URL, or submission message.

Update Unsubscribe Link by ID. To update a specific unsubscribe link. You can modify the link's name, page type, custom URL, standard page message, submission action type, redirect URL, or submission message.

Update a user group. To update the name, description, and member sources of an existing user group in your Zoho CRM organization.

Variable Groups. To update the details of one or more variable groups in your Zoho CRM organization. The request accepts a maximum of 10 variable group items. When individual items succeed or fail independently, the API returns a 207 multi-status response with per-item results.

Update variable group by ID. To update the details of a specific variable group by its ID in your Zoho CRM organization.

Update variables. Updates one or more CRM variables in a single request. The id key is mandatory in the request body to identify each variable. You cannot update the type or variable group of a variable. Requires the ZohoCRM.settings.variables.UPDATE scope.

Specific variable. Updates a specific CRM variable identified by its ID or API name. You cannot update the type or variable group of the variable. For the list of updatable input keys, refer to the Create Variables operation. Requires the ZohoCRM.settings.variables.UPDATE scope.

Update Zia Enrichment Configurations for a specific module. Updates Zia Enrichment Configurations for a specific module by ID. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to get CRM field IDs and API names, and the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to get module IDs and API names.

Update users. To update the details of one or more users in your Zoho CRM organization. The request must include a users array with up to 10 user records, each identified by a unique user ID. You can update user profile settings, role assignments, locale preferences, and other account details.

Update a single user by user ID. To update the details of a specific user in your Zoho CRM organization by user ID.

Add territories to a user. To associate one or more territories with a specific user in your Zoho CRM organization.