Skip to content
Changelog

Report a bug

Zoho CRM integration: operations for AI agents

Zoho CRM connects to Type.com as an integration. This page lists the 452 operations documented for Claude and Codex in Type.com: 173 read, 203 write, 76 destructive.

About Zoho CRM

Zoho CRM REST API v8 reference. This page covers CRM operations; other Zoho applications are separate products. CRM operations require a configured connection with the appropriate granted CRM scopes.

Categories: Sales & CRM

How to connect Zoho CRM to Type.com

Access
Organization connection: one shared account for the workspace.

To add the connection, follow the steps in Space connections.

Documented operations

452 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

452 operations listed.

List of Available APIs

  • Read

    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 /crm/v8/__apis

Appointment Preferences Apis

  • Read

    Get Appointment Preferences

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

    GET /crm/v8/settings/appointment_preferences

  • Write

    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.

    PUT /crm/v8/settings/appointment_preferences

Appointments Apis

  • Read

    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 included when retrieving multiple appointments. The API returns field values containing sensitive health data only when the Restrict Data access through API option is disabled in compliance settings.

    GET /crm/v8/Appointments__s

  • Read

    Get an Appointment Record by ID

    To retrieve the details of a single appointment record from your Zoho CRM organization.

    GET /crm/v8/Appointments__s/{appointmentId}

  • Write

    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.

    PUT /crm/v8/Appointments__s

  • Write

    Create Appointment records

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

    POST /crm/v8/Appointments__s

  • Write

    Update an Appointment Record by ID

    To update a single appointment record by its ID in your Zoho CRM organization.

    PUT /crm/v8/Appointments__s/{appointmentId}

  • Destructive

    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 /crm/v8/Appointments__s

  • Destructive

    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 /crm/v8/Appointments__s/{appointmentId}

Assignment Rules

  • Read

    Assignment Rules

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

    GET /crm/v8/settings/automation/assignment_rules

  • Read

    Specific Assignment Rule details

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

    GET /crm/v8/settings/automation/assignment_rules/{id}

  • Read

    Assignment Rules Count

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

    GET /crm/v8/settings/automation/assignment_rules/actions/count

  • Read

    Assignment Rule Associations

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

    GET /crm/v8/settings/automation/assignment_rules/{id}/actions/associations

  • Write

    Create an Assignment Rule

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

    POST /crm/v8/settings/automation/assignment_rules

  • Write

    Update a Specific Assignment Rule

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

    PUT /crm/v8/settings/automation/assignment_rules/{id}

  • Write

    Clone Assignment Rule

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

    POST /crm/v8/settings/automation/assignment_rules/{id}/actions/clone

  • Write

    Clone Assignment Rule Entries

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

    PUT /crm/v8/settings/automation/assignment_rules/{id}/actions/clone_entries

  • Write

    Reorder Assignment Rule entries

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

    PUT /crm/v8/settings/automation/assignment_rules/{id}/actions/reorder_entries

  • Destructive

    Delete an Assignment Rule

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

    DELETE /crm/v8/settings/automation/assignment_rules/{id}

Zoho CRM Associate Email API

  • Write

    Associate Email

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

    POST /crm/v8/{module}/{recordId}/actions/associate_email

Attachments API

  • Read

    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 /crm/v8/{moduleApiName}/{recordId}/Attachments/{id}

  • Read

    Retrieve All Attachments

    Retrieves all attachments associated with a specific record in a module.

    GET /crm/v8/{moduleApiName}/{recordId}/Attachments

  • Write

    Upload an Attachment

    Uploads an attachment by providing either a file or a valid URL. Maximum request body size: 100MB.

    POST /crm/v8/{moduleApiName}/{recordId}/Attachments

  • Destructive

    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.

    DELETE /crm/v8/{moduleApiName}/{recordId}/Attachments/{id}

Audit Log Export

  • Read

    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 /crm/v8/settings/audit_log_export

  • Read

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

    GET /crm/v8/settings/audit_log_export/{id}

  • Write

    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.

    POST /crm/v8/settings/audit_log_export

Bulk Read

  • Read

    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 /crm/v8/read/{jobId}

  • Read

    Download bulk read result

    To download the exported records from a completed bulk read job in Zoho CRM. This API returns a ZIP archive containing the CSV or ICS file with the exported records. The bulk read job must have a COMPLETED state before you can download the result.

    GET /crm/v8/read/{jobId}/result

  • Write

    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.

    POST /crm/v8/read

Bulk Write

  • Read

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

    GET /crm/v8/write/{jobId}

  • Write

    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 notified on completion or failure.

    POST /crm/v8/write

Business Hours

  • Read

    Business Hours Configuration

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

    GET /crm/v8/settings/business_hours

  • Write

    Business Hours Configuration

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

    POST /crm/v8/settings/business_hours

  • Write

    Business Hours Configuration

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

    PUT /crm/v8/settings/business_hours

Cadences

  • Read

    List Cadences

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

    GET /crm/v8/settings/automation/cadences

  • Read

    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 /crm/v8/settings/automation/cadences/{id}

  • Read

    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 /crm/v8/settings/automation/cadences/actions/records_count

  • Read

    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, and failed counts), email_notifications (sent, opened, clicked, replied, bounced, unsubscribed, and unsent counts), and whatsapp_message_notification (delivered and failed counts). Use the **filters** parameter to restrict results to a single action type, and the **follow_ups_executed_from** and **follow_ups_executed_till** parameters to restrict to a time range.

    GET /crm/v8/settings/automation/cadences/{id}/actions/analytics

  • Read

    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 /crm/v8/settings/automation/cadences/actions/count

  • Write

    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 links can be expressed in a single request before server ids are assigned. The cadence must be published and activated before it will enroll records.

    POST /crm/v8/settings/automation/cadences

  • Write

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

    PUT /crm/v8/settings/automation/cadences

  • Write

    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.

    PUT /crm/v8/settings/automation/cadences/{id}

  • Write

    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 be published before it can enroll records.

    POST /crm/v8/settings/automation/cadences/{id}/actions/clone

  • Write

    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 subscribes to the email engagement triggers required for signal-based follow-ups.

    POST /crm/v8/settings/automation/cadences/{id}/actions/activate

  • Write

    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.

    POST /crm/v8/settings/automation/cadences/{id}/actions/deactivate

  • Write

    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. Before publishing, ensure the cadence contains at least one follow-up and complies with the action count and active cadence limits. When the enrollment type is `custom_view`, the `process_existing_records` parameter determines whether records that already match the custom view are enrolled at the time of publication.

    POST /crm/v8/settings/automation/cadences/{id}/actions/publish

  • Destructive

    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 enrollment history is retained.

    DELETE /crm/v8/settings/automation/cadences/{id}

Cadence Execution

  • Write

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

    POST /crm/v8/{module}/actions/enrol_in_cadences

  • Write

    Un-enroll Records from Cadences

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

    POST /crm/v8/{module}/actions/unenrol_from_cadences

Call Preferences

  • Read

    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 /crm/v8/settings/call_preferences

  • Write

    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, Blueprint, or Workflow, or when the organization has an active telephony integration or active calendar booking for calls that depends on it.

    PUT /crm/v8/settings/call_preferences

Cancel Meetings

  • Write

    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 from the [Get Records API](record.yaml#$.paths./module.get).

    POST /crm/v8/Events/{event}/actions/cancel

Change Owner

  • Write

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

    POST /crm/v8/{module}/{record}/actions/change_owner

  • Write

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

    POST /crm/v8/{module}/actions/change_owner

Composite Request

  • Write

    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 sub-requests are rolled back if any subsequent sub-request fails.

    POST /crm/v8/__composite_requests

Contact Roles

  • Read

    List Contact Roles

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

    GET /crm/v8/Contacts/roles

  • Read

    Get a Contact Role

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

    GET /crm/v8/Contacts/roles/{role}

  • Write

    Create Contact Roles

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

    POST /crm/v8/Contacts/roles

  • Write

    Update Contact Roles

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

    PUT /crm/v8/Contacts/roles

  • Write

    Update a Contact Role

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

    PUT /crm/v8/Contacts/roles/{role}

  • Destructive

    Delete Contact Roles

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

    DELETE /crm/v8/Contacts/roles

  • Destructive

    Delete a Contact Role

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

    DELETE /crm/v8/Contacts/roles/{role}

Zoho CRM Lead Conversion Options API

  • Read

    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.

    GET /crm/v8/Leads/{leadId}/__conversion_options

Zoho CRM Lead Conversion API

  • Write

    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.

    POST /crm/v8/Leads/{leadId}/actions/convert

Coql

  • Read

    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.

    POST /crm/v8/coql

Currencies

  • Read

    List currencies

    Retrieves all added currencies in the organization.

    GET /crm/v8/org/currencies

  • Read

    Specific Currency

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

    GET /crm/v8/org/currencies/{currency}

  • Write

    Create currencies

    Creates one or more new currencies for the organization.

    POST /crm/v8/org/currencies

  • Write

    Update currencies

    Updates one or more currencies other than the base currency.

    PUT /crm/v8/org/currencies

  • Write

    Currency

    Update a specific currency by its unique ID.

    PUT /crm/v8/org/currencies/{currency}

  • Write

    Enable multi-currency

    Enable multi-currency for the organization and set the base currency.

    POST /crm/v8/org/currencies/actions/enable

  • Write

    Update base currency

    Update existing base currency details.

    PUT /crm/v8/org/currencies/actions/enable

Custom Views

  • Read

    Get All Custom Views

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

    GET /crm/v8/settings/custom_views

  • Read

    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.

    GET /crm/v8/settings/custom_views/{id}

  • Write

    Custom Views

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

    PUT /crm/v8/settings/custom_views

  • Write

    CustomView creation

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

    POST /crm/v8/settings/custom_views

  • Write

    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.

    PUT /crm/v8/settings/custom_views/{id}

  • Write

    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.

    PUT /crm/v8/settings/custom_views/actions/change_sort

  • Write

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

    PUT /crm/v8/settings/custom_views/{id}/actions/change_sort

  • Destructive

    Delete Custom Views

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

    DELETE /crm/v8/settings/custom_views

Data Sharing

  • Read

    Data Sharing Settings

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

    GET /crm/v8/settings/data_sharing

  • Write

    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.

    PUT /crm/v8/settings/data_sharing

Deal Contact Roles

  • Read

    Deal Contact Roles

    Retrieve contact roles associated with a deal.

    GET /crm/v8/{module}/{dealId}/Contact_Roles

  • Read

    Deal Contact Roles

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

    GET /crm/v8/{module}/{dealId}/Contact_Roles/{contactId}

  • Write

    Deal Contact Roles

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

    PUT /crm/v8/{module}/{dealId}/Contact_Roles

  • Write

    Deal Contact Roles

    Assign or update a contact role for a specific contact on a deal.

    PUT /crm/v8/{module}/{dealId}/Contact_Roles/{contactId}

  • Destructive

    Deal Contact Roles

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

    DELETE /crm/v8/{module}/{dealId}/Contact_Roles

  • Destructive

    Deal Contact Roles

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

    DELETE /crm/v8/{module}/{dealId}/Contact_Roles/{contactId}

Deal Link Emails

  • Write

    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 Mechanism](https://help.zoho.com/portal/en/kb/crm/connect-with-customers/email/user-functions/articles/email-association-with-deal#Auto-link_Emails_by_Deal_Prediction_Mechanism). You can also manage these links using the Link Deal to Emails API and [Unlink Deal from Emails API](deal_link_emails.yaml#$.paths./Contacts/{contactId}/Emails/{messageId}/actions/link_record.delete).

    POST /crm/v8/Contacts/{contactId}/Emails/actions/link_record

  • Write

    Link Deal Email

    Links an email to a specified record in CRM.

    POST /crm/v8/Contacts/{contactId}/Emails/{messageId}/actions/link_record

  • Destructive

    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.

    DELETE /crm/v8/Contacts/{contactId}/Emails/actions/link_record

  • Destructive

    Unlink Deal Email

    Unlinks an email from a specified record in CRM.

    DELETE /crm/v8/Contacts/{contactId}/Emails/{messageId}/actions/link_record

Download Email Attachments

  • Read

    Download an email attachment

    To download the binary content of an attachment that belongs to an email associated with a record in your Zoho CRM organization.

    GET /crm/v8/{module}/{recordId}/Emails/actions/download_attachments

Download Inline Images of an Email

  • Read

    Download an inline image from an email

    To download an inline image embedded in an email associated with a record in your Zoho CRM organization.

    GET /crm/v8/{module}/{recordId}/Emails/actions/download_inline_images

Duplicate Check Preference

  • Read

    Get Duplicate Check Preference

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

    GET /crm/v8/settings/duplicate_check_preference

  • Write

    Create Duplicate Check Preference

    To enable duplicate check preference for the Leads module in your Zoho CRM organization.

    POST /crm/v8/settings/duplicate_check_preference

  • Write

    Update Duplicate Check Preference

    Update Duplicate Check Preference API is used to update duplicate check settings for a specific module in the CRM system. It allows users to define how duplicate records are identified and managed based on field mappings between the current module and a mapped module, such as Contacts. This API helps maintain data integrity by preventing the creation of duplicate records during data entry or import processes.

    PUT /crm/v8/settings/duplicate_check_preference

  • Destructive

    Delete Duplicate Check Preference

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

    DELETE /crm/v8/settings/duplicate_check_preference

Email Drafts

  • Read

    List Email Drafts for a Record

    Retrieves the list of email drafts associated with the specified record in the given module.

    GET /crm/v8/{module}/{record}/__email_drafts

  • Read

    Get an Email Draft

    Retrieves the specified email draft for the given record in the module.

    GET /crm/v8/{module}/{record}/__email_drafts/{draft}

  • Write

    Create Email Drafts for a Record

    Creates one or more email drafts associated with the specified record in the given module.

    POST /crm/v8/{module}/{record}/__email_drafts

  • Write

    Update Email Drafts for a Record

    Updates one or more email drafts associated with the specified record in the given module.

    PUT /crm/v8/{module}/{record}/__email_drafts

  • Write

    Update an Email Draft

    Updates the specified email draft for the given record in the module.

    PUT /crm/v8/{module}/{record}/__email_drafts/{draft}

  • Destructive

    Delete an Email Draft

    Deletes the specified email draft for the given record.

    DELETE /crm/v8/{module}/{record}/__email_drafts/{draft}

Email Templates

  • Read

    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 sortable by last_usage_time, modified_time, or name, and paginated using the page and per_page parameters.

    GET /crm/v8/settings/email_templates

Email Sharing Details

  • Read

    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.

    GET /crm/v8/{moduleApiName}/{id}/__emails_sharing_details

Features

  • Read

    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.

    GET /crm/v8/__features

  • Read

    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.

    GET /crm/v8/__features/{feature}

  • Read

    User Licenses Feature

    To get the user licenses feature details for the current edition

    GET /crm/v8/__features/user_licenses

Fetch Full Data

  • Read

    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 text fields - other field types are not supported. Only data from rich text multi-line fields can be retrieved; multi-line fields of other types (small, large) are not supported.

    GET /crm/v8/{moduleApiName}/actions/fetch_full_data

  • Read

    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 exclusively fetches rich text fields - other field types are not supported. Only data from rich text multi-line fields can be retrieved; multi-line fields of other types (small, large) are not supported.

    GET /crm/v8/{moduleApiName}/{id}/actions/fetch_full_data

Field Updates API

  • Read

    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 metadata API to get module API names and IDs. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) before associating them with workflow rules via the associate action.

    GET /crm/v8/settings/automation/field_updates

  • Read

    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 more of field_label, enable_colour_code, pick_list_values.colour_code, data_type, or display_value. Use the [Get Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the field IDs and the [Get Modules API](modules.yaml#$.paths./settings/modules.get) to retrieve the module IDs. This API is useful for inspecting the current configuration of a Field Update action before updating it.

    GET /crm/v8/settings/automation/field_updates/{id}

  • Write

    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 fields) specifies how to update the field and is supported only for multi-select fields: overwrite replaces existing values, append adds to existing values. dependent_fields specifies fields affected when the target field changes — primarily used for picklist dependencies, where one field's value controls another's valid options. For example, updating Country to India restricts the dependent State field to Indian states.

    POST /crm/v8/settings/automation/field_updates

  • Write

    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 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 fields) specifies how to update the field and is supported only for multi-select fields: overwrite replaces existing values, append adds to existing values. dependent_fields specifies fields affected when the target field changes — primarily used for picklist dependencies. For example, updating Country to India restricts the dependent State field to Indian states.

    PUT /crm/v8/settings/automation/field_updates/{id}

  • Destructive

    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 Field Updates API to retrieve the Field Update IDs. The response includes the success or failure status for each specified ID. Use the [Get Field Updates API](field_updates.yaml#$.paths./settings/automation/field_updates.get) to get the Field Update IDs.

    DELETE /crm/v8/settings/automation/field_updates

  • Destructive

    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.

    DELETE /crm/v8/settings/automation/field_updates/{id}

Fields API

  • Read

    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 /crm/v8/settings/fields

  • Read

    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 /crm/v8/settings/fields/{fieldId}

  • Read

    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.

    GET /crm/v8/settings/fields/{fieldId}/actions/scheduled_jobs

  • Write

    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.

    POST /crm/v8/settings/fields

  • Write

    Update custom fields

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

    PATCH /crm/v8/settings/fields

  • Write

    Update a custom field

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

    PATCH /crm/v8/settings/fields/{fieldId}

  • Destructive

    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 /crm/v8/settings/fields/{fieldId}

Files

  • Read

    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 file ID does not correspond to any file in ZFS, a 204 No Content response is returned. This endpoint is used to download files that have been previously uploaded to ZFS and associated with Zoho CRM records.

    GET /crm/v8/files

  • Write

    Upload files to ZFS

    To upload one or more files to the Zoho File System (ZFS) in your Zoho CRM account. The API returns an encrypted file ID for each uploaded file, which you can use to attach the file to a file upload field, image upload field, or record image field through the Create or Update Records API. The file is uploaded using multipart/form-data with a required 'file' field containing the binary data of the file to be uploaded. The response includes the file ID, name, status, and other details. Can upload 10 files in a single request by repeating the 'file' field. Maximum file size is 20 MB.

    POST /crm/v8/files

Find And Merge

  • Read

    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.

    GET /crm/v8/{module}/{masterRecordId}/actions/merge

  • Write

    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.

    POST /crm/v8/{module}/{masterRecordId}/actions/merge

Fiscal Year

  • Read

    Get Fiscal Year Settings

    To retrieve the fiscal year settings configured for your Zoho CRM organization.

    GET /crm/v8/settings/fiscal_year

  • Write

    Update Fiscal Year Settings

    Updates the fiscal year configuration for the organization. Only administrators can update fiscal year settings.

    PUT /crm/v8/settings/fiscal_year

From Addresses

  • Read

    Get from addresses

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

    GET /crm/v8/settings/emails/actions/from_addresses

Related Records Count

  • Write

    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 the count of records in the following types of related lists: - **System-defined related lists**, such as: - Survey - Desk - Projects - Visits - Expense - Invoice - Subscription - **Custom related lists** created via Lookup fields. - **Custom related lists** created via Multi-select Lookup fields. - **Custom related lists** created via Multi-module Lookup fields. - **Related lists** created when history tracking is enabled for a picklist field.

    POST /crm/v8/{moduleApiName}/{recordId}/actions/get_related_records_count

Global Picklists

  • Read

    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 key, so that only the requested keys along with "id" are returned; use the "filters" query parameter to filter the global picklists themselves by the value of a key; and use the "inner_details_filters" query parameter to filter the inner details of the global picklists. A 204 is returned when no global picklists exist.

    GET /crm/v8/settings/global_picklists

  • Read

    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 204 is returned when no global picklists exist.

    GET /crm/v8/settings/global_picklists/{id}

  • Read

    Get Replaced Picklist Values

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

    GET /crm/v8/settings/global_picklists/{id}/actions/replaced_values

  • Read

    Get Field Associations

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

    GET /crm/v8/settings/global_picklists/{id}/actions/associations

  • Read

    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 /crm/v8/settings/global_picklists/{id}/actions/pick_list_values_associations

  • Write

    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.

    POST /crm/v8/settings/global_picklists

  • Write

    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 existing values (using id), move values between used/unused (one at a time), or delete values (one at a time using _delete: true). Bulk operations for moving to unused or deletion are not allowed.

    PATCH /crm/v8/settings/global_picklists

  • Write

    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 pick_list_values, you can add new values, update existing values (using id), move values between used/unused (one at a time), or delete values (one at a time using _delete: true). Bulk operations for moving to unused or deletion are not allowed.

    PATCH /crm/v8/settings/global_picklists/{id}

  • Write

    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) value must be in the **used** state of the picklist option.

    POST /crm/v8/settings/global_picklists/{id}/actions/replace_picklist_values

  • Destructive

    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 returned with error details.

    DELETE /crm/v8/settings/global_picklists

  • Destructive

    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, conversion in progress, association limits, or system-defined restrictions. When an error refers to a position in a multi-resource request/path, details.resource_path_index is provided.

    DELETE /crm/v8/settings/global_picklists/{id}

Holidays

  • Read

    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.

    GET /crm/v8/settings/holidays

  • Read

    A specific holiday

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

    GET /crm/v8/settings/holidays/{holidayId}

  • Write

    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.

    POST /crm/v8/settings/holidays

  • Write

    Multiple Holidays

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

    PUT /crm/v8/settings/holidays

  • Write

    A specific holiday

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

    PUT /crm/v8/settings/holidays/{holidayId}

  • Destructive

    Holiday

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

    DELETE /crm/v8/settings/holidays/{holidayId}

Convert Inventory Records

  • Write

    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.

    POST /crm/v8/{moduleApiName}/{id}/actions/convert

Inventory Templates

  • Read

    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.

    GET /crm/v8/settings/inventory_templates

  • Read

    Inventory Template

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

    GET /crm/v8/settings/inventory_templates/{templateId}

Layouts API

  • Read

    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 own set of layouts. - Score and Visit Summary sections are system-generated and read-only. - The API returns all layouts for the module in a single response; pagination is not supported.

    GET /crm/v8/settings/layouts

  • Read

    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 per pipeline. Each pipeline can have its own set of layouts. - The `mode` parameter filters the layout by mode. Possible values: **all**, **business_card**, **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.

    GET /crm/v8/settings/layouts/{id}

  • Write

    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.

    PATCH /crm/v8/settings/layouts/{id}

  • Destructive

    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. Specifying a transfer target is optional only when the layout is deactivated and has no associated records. Only one custom layout can be deleted per API call, and the standard layout cannot be deleted.

    DELETE /crm/v8/settings/layouts/{id}

Layout Activate and Deactivate API

  • Write

    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 (ALREADY_ACTIVATED). The status key in the response from the [Get Layouts API](layouts.yaml#$.paths./settings/layouts.get) indicates whether the layout is active or inactive.

    POST /crm/v8/settings/layouts/{id}/actions/activate

  • Destructive

    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 (ALREADY_DEACTIVATED).

    DELETE /crm/v8/settings/layouts/{id}/actions/activate

Locking Information

  • Read

    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 /crm/v8/{moduleName}/{recordId}/Locking_Information__s

  • Read

    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.

    GET /crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId}

  • Write

    Lock a record

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

    POST /crm/v8/{moduleName}/{recordId}/Locking_Information__s

  • Write

    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.

    PUT /crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId}

  • Destructive

    Remove lock from a locked record

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

    DELETE /crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId}

Mail Merge APIs

  • Write

    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.

    POST /crm/v8/{moduleApiName}/{recordId}/actions/send_mail_merge

  • Write

    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.

    POST /crm/v8/{moduleApiName}/{recordId}/actions/sign_mail_merge

  • Write

    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.

    POST /crm/v8/{moduleApiName}/{recordId}/actions/download_mail_merge

Map Dependency API

  • Read

    Get field dependencies for a layout

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

    GET /crm/v8/settings/layouts/{layoutId}/map_dependency

  • Read

    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.

    GET /crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId}

  • Write

    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 Picklist fields can be used only as child fields. - Parent and child fields must belong to the selected layout. - When using subform fields, the parent and child fields must belong to the same subform. To create a field dependency between a parent picklist field and a child picklist field for a specific layout in your Zoho CRM organization.

    POST /crm/v8/settings/layouts/{layoutId}/map_dependency

  • Write

    Update an existing field dependency

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

    PUT /crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId}

  • Destructive

    Delete a field dependency

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

    DELETE /crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId}

Mass Change Owner

  • Read

    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.

    GET /crm/v8/{module}/actions/mass_change_owner

  • Write

    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 job and returns a job ID, which you can use to check the job status. Job statuses are available for up to 60 days. The Mass Change Owner API is available only in the Enterprise and Ultimate editions. The OAuth scope enforced is specific to the target module (for example, **ZohoCRM.change_owner.leads.CREATE** for Leads); modules without a dedicated scope fall back to a generic custom-module scope.

    POST /crm/v8/{module}/actions/mass_change_owner

Mass convert APIs

  • Read

    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.

    GET /crm/v8/Leads/actions/mass_convert

  • Write

    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.

    POST /crm/v8/Leads/actions/mass_convert

Mass Delete Records API

  • Read

    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 /crm/v8/{module}/actions/mass_delete

  • Destructive

    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.

    POST /crm/v8/{module}/actions/mass_delete

Mass Delete Tags APIs

  • Read

    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 /crm/v8/settings/tags/actions/mass_delete

  • Destructive

    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.

    POST /crm/v8/settings/tags/actions/mass_delete

Mass Update API

  • Read

    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, updated, not-updated, and failed record counts so that the caller can track progress until the job completes.

    GET /crm/v8/{module}/actions/mass_update

  • Write

    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 records per request. In the scheduler mode, the caller supplies a Custom View ID in `cvid` and the request schedules an asynchronous background job that processes up to 50,000 records matching the view; the response returns a `job_id` that can be passed to the corresponding GET endpoint to track the job's progress. The Deals module accepts up to three fields per request; all other supported modules accept only one field per request. Email, lookup, multi-line, layout, and line item fields cannot be mass updated.

    POST /crm/v8/{module}/actions/mass_update

Search Records

  • Read

    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.

    GET /crm/v8/{module}/search

  • Write

    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 must specify at least one of the following search parameters: criteria, email, phone, or word. A maximum of 2,000 records can be retrieved per search, with up to 15 criteria conditions. Newly created or updated records may not appear immediately in the search results due to indexing delays.

    POST /crm/v8/{module}/bulk/search

Modules

  • Read

    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 criteria. Returns all matching modules in a single response without pagination.

    GET /crm/v8/settings/modules

  • Read

    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

    GET /crm/v8/settings/modules/{moduleIdentifier}

  • Write

    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 result in validation errors. The optional access_type controls module access model (org_based/team_based).

    POST /crm/v8/settings/modules

  • Write

    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 be updated and must not be included in the request body. This operation is idempotent - submitting the same request multiple times produces the same result.

    PUT /crm/v8/settings/modules

  • Write

    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

    PUT /crm/v8/settings/modules/{moduleIdentifier}

Notes

  • Read

    Notes

    Retrieves a list of notes.

    GET /crm/v8/Notes

  • Read

    Get a Specific Note

    Retrieves details of a specific note by its ID.

    GET /crm/v8/Notes/{id}

  • Write

    Create Notes

    Creates one or more note records.

    POST /crm/v8/Notes

  • Write

    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.

    PUT /crm/v8/Notes

  • Write

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

    PUT /crm/v8/Notes/{id}

  • Destructive

    Notes

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

    DELETE /crm/v8/Notes

  • Destructive

    Delete a Specific Note

    Permanently deletes a specific note by its ID.

    DELETE /crm/v8/Notes/{id}

Notifications

  • Read

    List active notification channels

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

    GET /crm/v8/actions/watch

  • Write

    Create notification channels

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

    POST /crm/v8/actions/watch

  • Write

    Update full notification details

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

    PUT /crm/v8/actions/watch

  • Write

    Update notification channel information

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

    PATCH /crm/v8/actions/watch

  • Destructive

    Disable notification channels

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

    DELETE /crm/v8/actions/watch

Org

  • Read

    Get organization details

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

    GET /crm/v8/org

Org photo

  • Read

    Organization photo

    To retrieve the organization photo for your Zoho CRM organization.

    GET /crm/v8/org/photo

  • Write

    Upload Organization Photo

    To upload a photo for your Zoho CRM organization.

    POST /crm/v8/org/photo

  • Destructive

    Delete the organization photo

    To delete the organization photo from your Zoho CRM organization.

    DELETE /crm/v8/org/photo

Pick List Values

  • Read

    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 /crm/v8/settings/fields/{fieldId}/pick_list_values

  • Read

    get a picklist field option

    Picklist field option GET

    GET /crm/v8/settings/fields/{fieldId}/pick_list_values/{pickListValueId}

  • Write

    Replace Pick list values

    Replace picklist value

    POST /crm/v8/settings/fields/{fieldId}/actions/replace_pick_list_values

  • Destructive

    Delete a picklist field option

    Delete picklist field option

    DELETE /crm/v8/settings/fields/{fieldId}/pick_list_values/{pickListValueId}

Pipeline

  • Read

    Pipelines

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

    GET /crm/v8/settings/pipeline

  • Read

    Specific Pipeline

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

    GET /crm/v8/settings/pipeline/{pipelineIdentifier}

  • Write

    Pipeline

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

    POST /crm/v8/settings/pipeline

  • Write

    Pipeline

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

    PATCH /crm/v8/settings/pipeline

  • Write

    Pipeline

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

    PUT /crm/v8/settings/pipeline

  • Write

    Pipeline

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

    PATCH /crm/v8/settings/pipeline/{pipelineIdentifier}

  • Write

    Pipeline

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

    PUT /crm/v8/settings/pipeline/{pipelineIdentifier}

  • Destructive

    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.

    POST /crm/v8/settings/pipeline/actions/transfer

Portal User Types

  • Read

    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.

    GET /crm/v8/settings/portals/{portal}/user_type

  • Read

    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.

    GET /crm/v8/settings/portals/{portal}/user_type/{userTypeId}

  • Write

    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.

    POST /crm/v8/settings/portals/{portal}/user_type

  • Write

    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.

    PUT /crm/v8/settings/portals/{portal}/user_type/{userTypeId}

  • Destructive

    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.

    DELETE /crm/v8/settings/portals/{portal}/user_type/{userTypeId}

Portal Users

  • Read

    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.

    GET /crm/v8/settings/portals/{portal}/user_type/{userType}/users

  • Read

    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.

    GET /crm/v8/{module}/actions/portal_invite

  • Write

    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.

    POST /crm/v8/{module}/actions/portal_invite

  • Write

    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.

    POST /crm/v8/{module}/{recordId}/actions/portal_invite

  • Write

    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.

    POST /crm/v8/settings/portals/{portal}/user_type/{userType}/users/action/transfer

  • Write

    Change status of portal users

    Changing portal users status.

    PUT /crm/v8/settings/portals/{portal}/user_type/{userType}/users/{recordId}/actions/change_status

  • Write

    Portal User Status

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

    PUT /crm/v8/settings/portals/{portal}/user_type/{userType}/users/actions/change_status

  • Destructive

    delete portal users

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

    DELETE /crm/v8/settings/portals/{portal}/user_type/{userType}/users

Portals

  • Read

    Portals

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

    GET /crm/v8/settings/portals

  • Read

    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.

    GET /crm/v8/settings/portals/{portal}

  • Write

    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.

    POST /crm/v8/settings/portals

  • Write

    Portal

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

    PUT /crm/v8/settings/portals/{portal}

Profiles API

  • Read

    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 Profiles](https://www.zoho.com/crm/developer/docs/api/v8/get-profiles.html). **Scopes:** * ZohoCRM.settings.profiles.ALL * ZohoCRM.settings.profiles.READ

    GET /crm/v8/settings/profiles

  • Read

    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 /crm/v8/settings/profiles/{id}

  • Write

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

    POST /crm/v8/settings/profiles/{id}/actions/clone

  • Write

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

    PUT /crm/v8/settings/profiles/{id}

  • Write

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

    PATCH /crm/v8/settings/profiles/{id}

  • Destructive

    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 Profile](https://www.zoho.com/crm/developer/docs/api/v8/transfer-delete-profile.html).

    DELETE /crm/v8/settings/profiles/{id}

Records

  • Read

    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" (maximum 200). To fetch more than 2000 records, use the "page_token" returned in the response. Consecutive page tokens can be used to navigate through up to 100,000 records. The "$has_more" key is returned when fetching a specific record and indicates whether more records are available in subforms, multi-select lookup fields, and multi-user lookup fields. To retrieve details of a related list, use the [Get Related Records API](related_records.yaml#$.paths./{parentRecordModule}/{parentRecord}/{relatedList}.get).

    GET /crm/v8/{module}

  • Read

    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.

    GET /crm/v8/{module}/deleted

  • Read

    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 /crm/v8/{module}/{recordId}

  • Write

    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. You can create up to 100 records in a single API call. Specify the required field API names and their corresponding values in the request body.

    POST /crm/v8/{module}

  • Write

    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 records can be updated per API call. Use only Field API names in the input. You can update all fields supported by the Insert Records API operation. When updating multiple records, the response array maintains the same order as the input records, allowing each response to be mapped to its corresponding input record. To update multiple subform records, specify the subform API name as a key within the record and provide the subform records as a JSON array. Use the subform field API names as keys within each subform record. For detailed information on subforms, refer to the [Manipulating Subform using Zoho CRM APIs](https://help.zoho.com/portal/en/community/topic/kaizen-124-accessing-subform-using-zoho-crm-apis). Use the [Modules API](modules.yaml#$.paths./settings/modules.get) and [Fields Metadata API](fields.yaml#$.paths./settings/fields.get) to retrieve the API names of the subform and its fields. To update an existing subform record, include its record ID in the subform JSON array. Use the [Get Records API](record.yaml#$.paths./module.get) with the subform API name to retrieve subform record IDs. When adding a new subform record, it is appended to the existing records. Passing an empty JSON array for a subform deletes all its records. To delete a specific subform record, specify its record ID and set "_delete" to "null". Deleting the parent record also deletes all its subform records.

    PUT /crm/v8/{module}

  • Write

    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 duplicate check fields: system-defined duplicate check fields and user-defined unique fields. System-defined duplicate check fields are predefined unique fields for each module. The system automatically checks these fields to prevent duplicate records. Refer to the System-defined Duplicate Check Fields section for module-specific details. User-defined unique fields are fields for which the "Do not allow duplicate values" option is enabled. These fields allow users to define custom fields for duplicate checking. For more information, refer to [Mark a Field as Unique](https://help.zoho.com/portal/en/kb/crm/customize-crm-account/customizing-fields/articles/use-custom-fields#Mark_a_Field_as_Unique). When a record is upserted, the system first checks for duplicates in these fields. If a matching record exists, it gets updated; otherwise, a new record is inserted. You can specify the order in which the system checks for duplicate records using the "duplicate_check_fields" array in the API request. The array can contain system-defined duplicate check fields, such as "Email" for the Leads module, and user-defined unique fields, such as "Phone" and "Fax". For example, in the Leads module, you can specify: "duplicate_check_fields": ["Email", "Phone", "Fax"]. If "duplicate_check_fields" is not specified, the system checks duplicate records in the following order: 1. System-defined duplicate check fields. 2. User-defined unique fields.

    POST /crm/v8/{module}/upsert

  • Write

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

    PUT /crm/v8/{module}/{recordId}

  • Write

    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 are copied to the cloned record. To modify or add field values, specify the field API names and their corresponding values in the input body. If no field values need to be modified, the input body can be omitted. Mandatory fields specified in the input must not be null. The Sample Inputs, Sample Responses, and Possible Errors documented for the [Insert Records API](record.yaml#$.paths./module.post) also apply to the [Record Clone API](record.yaml#$.paths./{module}/{recordId}/actions/clone.post).

    POST /crm/v8/{module}/{recordId}/actions/clone

  • Destructive

    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 the deleted records are also deleted.

    DELETE /crm/v8/{module}

  • Destructive

    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.

    DELETE /crm/v8/{module}/{recordId}

Module Record Count

  • Read

    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 same request. The `converted` and `approved` parameters apply only to the Leads module. The `type` parameter applies only to the Users module. Note: The record count may take 1-10 minutes to reflect the latest changes in Zoho CRM. 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).

    GET /crm/v8/{moduleApiName}/actions/count

Record Locking Configuration

  • Read

    Get record locking configuration

    Retrieves the existing record locking configuration for the specified module.

    GET /crm/v8/settings/record_locking_configurations

  • Read

    Get specific record locking configuration

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

    GET /crm/v8/settings/record_locking_configurations/{id}

  • Write

    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.

    POST /crm/v8/settings/record_locking_configurations

  • Write

    Update record locking configuration

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

    PUT /crm/v8/settings/record_locking_configurations

  • Write

    Update specific record locking configuration

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

    PUT /crm/v8/settings/record_locking_configurations/{id}

  • Destructive

    Delete record locking configuration

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

    DELETE /crm/v8/settings/record_locking_configurations

  • Destructive

    Delete specific record locking configuration

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

    DELETE /crm/v8/settings/record_locking_configurations/{id}

Record Photo

  • Read

    Get a record photo

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

    GET /crm/v8/{module}/{record}/photo

  • Write

    Upload a record photo

    To upload a photo for a specific record in your Zoho CRM organization.

    POST /crm/v8/{module}/{record}/photo

  • Destructive

    Delete a record photo

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

    DELETE /crm/v8/{module}/{record}/photo

Record Email Sharing

  • Write

    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.

    POST /crm/v8/{moduleApiName}/{id}/actions/share_emails

  • Write

    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.

    POST /crm/v8/{moduleApiName}/{id}/actions/unshare_emails

  • Write

    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.

    POST /crm/v8/{moduleApiName}/actions/share_emails

  • Write

    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.

    POST /crm/v8/{moduleApiName}/actions/unshare_emails

Recycle Bin

  • Read

    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 supported by display name, deletion time, or deleted-by user in ascending or descending order.

    GET /crm/v8/settings/recycle_bin

  • Read

    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 /crm/v8/settings/recycle_bin/actions/count

  • Read

    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.

    GET /crm/v8/settings/recycle_bin/{recordId}

  • Write

    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 currently in the Recycle Bin. When restoring a parent record, Zoho CRM also restores all its associated child records, such as Notes and Attachments. If the total number of records to restore, including child records, is 1000 or fewer, the operation completes immediately. When the total exceeds 1000, when the **filters** option is applied, or when **restore_all_records** is **true**, the restoration runs as a background job. Admin users can restore any record; non-admin users can restore only the records they own unless their profile grants broader access.

    POST /crm/v8/settings/recycle_bin/actions/restore

  • Write

    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 immediately and returns a 200 response. When the total exceeds 1000, the operation is scheduled as a background job. Admin users can restore any record; non-admin users can restore only the records they own unless their profile grants broader access.

    POST /crm/v8/settings/recycle_bin/{recordId}/actions/restore

  • Destructive

    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 immediately and returns a 200 response with per-item results. When the total exceeds 1000, the deletion runs as a background job and returns a 202 response. Partial successes return a 207 multi-status response with individual success and error entries per record.

    DELETE /crm/v8/settings/recycle_bin

  • Destructive

    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 immediately and returns a 200 response. When the count exceeds 1000, the deletion runs as a background job and returns a 202 response. Only users with the Admin profile can empty the Recycle Bin.

    POST /crm/v8/settings/recycle_bin/actions/empty

  • Destructive

    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 total number of records to delete, including child records, exceeds 1000, the operation runs as a background job.

    DELETE /crm/v8/settings/recycle_bin/{recordId}

Related Lists

  • Read

    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 /crm/v8/settings/related_lists

Related Notes

  • Read

    Related Notes

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

    GET /crm/v8/{parentRecordModule}/{parentRecordId}/Notes

  • Read

    Specific Related Note

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

    GET /crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId}

  • Write

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

    POST /crm/v8/{parentRecordModule}/{parentRecordId}/Notes

  • Write

    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.

    PUT /crm/v8/{parentRecordModule}/{parentRecordId}/Notes

  • Write

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

    PUT /crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId}

  • Destructive

    Related Notes

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

    DELETE /crm/v8/{parentRecordModule}/{parentRecordId}/Notes

  • Destructive

    Related Note

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

    DELETE /crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId}

Zoho CRM Related Records API

  • Read

    Related Records

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

    GET /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}

  • Read

    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.

    GET /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record}

  • Read

    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.

    GET /crm/v8/{parentRecordModule}/deleted/{parentRecord}/{relatedList}

  • Write

    Update related records

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

    PUT /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}

  • Write

    Update a related record

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

    PUT /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record}

  • Destructive

    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.

    DELETE /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}

  • Destructive

    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.

    DELETE /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record}

Roles

  • Read

    Get all roles

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

    GET /crm/v8/settings/roles

  • Read

    Get a role

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

    GET /crm/v8/settings/roles/{role}

  • Write

    Create a role

    Creates a new role in your Zoho CRM organization.

    POST /crm/v8/settings/roles

  • Write

    Update a role

    Updates an existing role in your Zoho CRM organization.

    PUT /crm/v8/settings/roles

  • Write

    Update a role

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

    PUT /crm/v8/settings/roles/{role}

  • Destructive

    Delete a role

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

    DELETE /crm/v8/settings/roles/{role}

Scoring Rules

  • Read

    Scoring Rules

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

    GET /crm/v8/settings/automation/scoring_rules

  • Read

    Get scoring rule by ID

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

    GET /crm/v8/settings/automation/scoring_rules/{ruleId}

  • Write

    Scoring Rules

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

    PUT /crm/v8/settings/automation/scoring_rules

  • Write

    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.

    POST /crm/v8/settings/automation/scoring_rules

  • Write

    Update a scoring rules by ID

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

    PUT /crm/v8/settings/automation/scoring_rules/{ruleId}

  • Write

    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.

    PUT /crm/v8/settings/automation/scoring_rules/{ruleId}/actions/activate

  • Write

    Clone a scoring rule

    To clone a Scoring Rule in your Zoho CRM organization.

    POST /crm/v8/settings/automation/scoring_rules/{ruleId}/actions/clone

  • Destructive

    Scoring Rules

    Permanently deletes multiple scoring rules

    DELETE /crm/v8/settings/automation/scoring_rules

  • Destructive

    Delete a scoring rules by ID

    Permanently deletes a single scoring rule identified by ruleId

    DELETE /crm/v8/settings/automation/scoring_rules/{ruleId}

  • Destructive

    Deactivate a scoring rule

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

    DELETE /crm/v8/settings/automation/scoring_rules/{ruleId}/actions/activate

Send Mail

  • Write

    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.

    POST /crm/v8/{moduleName}/{id}/actions/send_mail

Service Preferences APIs

  • Read

    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.

    GET /crm/v8/settings/service_preferences

  • Write

    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.

    PUT /crm/v8/settings/service_preferences

Services Apis

  • Read

    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.

    GET /crm/v8/Services__s

  • Read

    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 /crm/v8/Services__s/{id}

  • Write

    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.

    PUT /crm/v8/Services__s

  • Write

    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.

    POST /crm/v8/Services__s

  • Write

    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.

    PUT /crm/v8/Services__s/{id}

  • Destructive

    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 /crm/v8/Services__s

  • Destructive

    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 /crm/v8/Services__s/{id}

Shared Records API

  • Read

    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.

    GET /crm/v8/{moduleApiName}/{recordId}/actions/share

  • Write

    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 User B. Now, User A can share the record successfully only if: > - User B is a **confirmed** and **active** user. > - User B **does not already have access** to that particular record. > - User B has access to that particular module. For instance, to share a contact, User B must have access to the Contacts module. > - You cannot share the records in Calls, Meetings, Tasks, and Linking modules directly. They can be shared as related lists. > - The users who have profiles with **share** permission can share any records that they have access to, except the records that are shared to them. To check the same, go to Setup > Users and Control > Security Control > Choose the profile > Tool Permissions. Check if **share** is enabled. It is enabled by default for Standard and Administrator Profiles. > - The details of the records that form many-to-many relationships (with multi-select lookup) cannot be shared. > - A record can be shared only with **10 users**, **5 groups**, and **5 roles**. > - Once the record gets shared successfully, the user who initiated the share operation can be notified via email.

    POST /crm/v8/{moduleApiName}/{recordId}/actions/share

  • Write

    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.

    PUT /crm/v8/{moduleApiName}/{recordId}/actions/share

  • Destructive

    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 /crm/v8/{moduleApiName}/{recordId}/actions/share

Shift Hours

  • Read

    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 /crm/v8/settings/business_hours/shift_hours

  • Read

    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.

    GET /crm/v8/settings/business_hours/shift_hours/{shift}

  • Write

    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 hours are not enabled for the org.

    POST /crm/v8/settings/business_hours/shift_hours

  • Write

    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.

    PUT /crm/v8/settings/business_hours/shift_hours

  • Write

    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.

    PUT /crm/v8/settings/business_hours/shift_hours/{shift}

  • Destructive

    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 /crm/v8/settings/business_hours/shift_hours/{shift}

Tags

  • Read

    Tags

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

    GET /crm/v8/settings/tags

  • Write

    Tags

    To update an existing tag in your Zoho CRM organization.

    PUT /crm/v8/settings/tags

  • Write

    Tags

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

    POST /crm/v8/settings/tags

  • Write

    Update tag by ID

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

    PUT /crm/v8/settings/tags/{id}

  • Destructive

    Delete tag by ID

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

    DELETE /crm/v8/settings/tags/{id}

Tag Actions API

  • Read

    Get Tag Records Count

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

    GET /crm/v8/settings/tags/{id}/actions/records_count

  • Write

    Add Tags to Records

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

    POST /crm/v8/{module}/actions/add_tags

  • Write

    Remove Tags from Records

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

    POST /crm/v8/{module}/actions/remove_tags

  • Write

    Add Tags to a Record

    Adds tags to a specific record in the specified module.

    POST /crm/v8/{module}/{id}/actions/add_tags

  • Write

    Remove Tags from a Record

    Removes tags from a specific record in the specified module.

    POST /crm/v8/{module}/{id}/actions/remove_tags

  • Write

    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.

    POST /crm/v8/settings/tags/{id}/actions/merge

Territories

  • Read

    Get all territories

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

    GET /crm/v8/settings/territories

  • Read

    Get territory by ID

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

    GET /crm/v8/settings/territories/{id}

  • Read

    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.

    GET /crm/v8/settings/territories/{id}/__child_territories

  • Read

    Get territory-associated user counts

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

    GET /crm/v8/settings/territories/actions/associated_users_count

  • Read

    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 /crm/v8/settings/territories/actions/scheduled_run_rule_jobs

  • Write

    Create Territories

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

    POST /crm/v8/settings/territories

  • Write

    Update territories

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

    PUT /crm/v8/settings/territories

  • Write

    Update a specific territory by its ID

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

    PUT /crm/v8/settings/territories/{id}

  • Write

    Assign territories to a record

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

    POST /crm/v8/{module}/{record}/actions/assign_territories

  • Write

    Assign territories to multiple records

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

    POST /crm/v8/{module}/actions/assign_territories

  • Write

    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.

    POST /crm/v8/{module}/{record}/actions/remove_territories

  • Write

    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.

    POST /crm/v8/{module}/actions/remove_territories

  • Write

    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.

    POST /crm/v8/settings/territories/actions/run_rules

  • Destructive

    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 /crm/v8/settings/territories

  • Destructive

    Delete a territory by ID

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

    DELETE /crm/v8/settings/territories/{id}

  • Destructive

    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.

    POST /crm/v8/settings/territories/actions/transfer_and_delete

  • Destructive

    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.

    POST /crm/v8/settings/territories/{id}/actions/transfer_and_delete

Territory Users

  • Read

    Territory Users

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

    GET /crm/v8/settings/territories/{territory}/users

  • Read

    Specific Territory User

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

    GET /crm/v8/settings/territories/{territory}/users/{user}

  • Write

    Territory Users

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

    PUT /crm/v8/settings/territories/{territory}/users

  • Write

    Territory User

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

    PUT /crm/v8/settings/territories/{territory}/users/{user}

  • Destructive

    Territory Users

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

    DELETE /crm/v8/settings/territories/{territory}/users

  • Destructive

    Territory User

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

    DELETE /crm/v8/settings/territories/{territory}/users/{user}

Timelines

  • Read

    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 /crm/v8/{module}/{recordId}/__timeline

Unblock Email Address API

  • Write

    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.

    POST /crm/v8/{module}/actions/unblock_email

  • Write

    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.

    POST /crm/v8/{module}/{id}/actions/unblock_email

Unsubscribe Links

  • Read

    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 /crm/v8/settings/unsubscribe_links/{id}

  • Read

    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 /crm/v8/settings/unsubscribe_link/actions/associations

  • Write

    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.

    PUT /crm/v8/settings/unsubscribe_links/{id}

  • Destructive

    Delete Unsubscribe Link by ID

    To delete a specific unsubscribe link. Note that the default unsubscribe link cannot be deleted.

    DELETE /crm/v8/settings/unsubscribe_links/{id}

Upload File

  • Write

    Upload a file to CRM

    To upload a CSV file in ZIP format for bulk write API. The response contains the **file_id**. Use this ID while making the bulk write request.

    POST /crm/v8/upload

User Groups

  • Read

    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 /crm/v8/settings/user_groups

  • Read

    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 /crm/v8/settings/user_groups/{group}

  • Read

    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.

    GET /crm/v8/settings/user_groups/{group}/sources

  • Read

    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 /crm/v8/settings/user_groups/{group}/actions/sources_count

  • Read

    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 /crm/v8/settings/user_groups/actions/associated_users_count

  • Read

    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 /crm/v8/users/{user}/actions/associated_groups

  • Read

    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 /crm/v8/settings/user_groups/{group}/actions/associations

  • Write

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

    POST /crm/v8/settings/user_groups

  • Write

    Update a user group

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

    PUT /crm/v8/settings/user_groups/{group}

  • Destructive

    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 /crm/v8/settings/user_groups/{group}

Users API

  • Read

    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 /crm/v8/users

  • Read

    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 /crm/v8/users/{user}

  • Write

    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.

    POST /crm/v8/users

  • Write

    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.

    PUT /crm/v8/users

  • Write

    Update a single user by user ID

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

    PUT /crm/v8/users/{user}

  • Destructive

    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.

    DELETE /crm/v8/users/{user}

User Territories

  • Read

    Get territories of a user

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

    GET /crm/v8/users/{user}/territories

  • Read

    Specific territory of a user

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

    GET /crm/v8/users/{user}/territories/{territory}

  • Write

    Add territories to a user

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

    PUT /crm/v8/users/{user}/territories

  • Destructive

    Remove territories from a user

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

    DELETE /crm/v8/users/{user}/territories

  • Destructive

    Remove territory from a user

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

    DELETE /crm/v8/users/{user}/territories/{territory}

Transfer And Delete User

  • Read

    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 /crm/v8/users/actions/transfer_and_delete

  • Read

    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 /crm/v8/users/actions/transfer

  • Read

    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.

    GET /crm/v8/users/{userId}/actions/validate_before_transfer

  • Write

    Transfer and delete a user

    Transfer user records, assignments, and criteria to another user

    POST /crm/v8/users/{userId}/actions/transfer_and_delete

  • Write

    Transfer and delete a user

    Transfer user records, assignments, and criteria to another user

    POST /crm/v8/users/actions/transfer_and_delete

  • Write

    Transfer a user

    Transfer user records, assignments, and criteria to another user

    POST /crm/v8/users/{userId}/actions/transfer

Variable Groups

  • Read

    Variable Groups

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

    GET /crm/v8/settings/variable_groups

  • Read

    Get variable group by ID

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

    GET /crm/v8/settings/variable_groups/{id}

  • Write

    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.

    PUT /crm/v8/settings/variable_groups

  • Write

    Update variable group by ID

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

    PUT /crm/v8/settings/variable_groups/{id}

  • Write

    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.

    POST /crm/v8/settings/variable_groups/actions/generate_api_name

Variables

  • Read

    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.

    GET /crm/v8/settings/variables

  • Read

    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.

    GET /crm/v8/settings/variables/{id}

  • Read

    Variable Associations

    Get associated variables

    GET /crm/v8/settings/variables/{id}/actions/associations

  • Write

    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.

    PUT /crm/v8/settings/variables

  • Write

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

    POST /crm/v8/settings/variables

  • Write

    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.

    PUT /crm/v8/settings/variables/{id}

  • Write

    Generate API Name

    generates api name

    POST /crm/v8/settings/variables/actions/generate_api_name

  • Destructive

    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. Requires the ZohoCRM.settings.variables.DELETE scope.

    DELETE /crm/v8/settings/variables

  • Destructive

    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 /crm/v8/settings/variables/{id}

Webhooks

  • Read

    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 ID](webhooks.yaml#$.paths./settings/automation/webhooks/{webhook_ID}.get) to retrieve the full configuration of a specific webhook.

    GET /crm/v8/settings/automation/webhooks

  • Read

    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.

    GET /crm/v8/settings/automation/webhooks/{webhookId}

  • Read

    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 **to** is 90 days.

    GET /crm/v8/settings/automation/webhook_failures

  • Read

    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 /crm/v8/settings/automation/webhooks/actions/associated_modules

  • Read

    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 /crm/v8/settings/automation/webhooks/actions/usage_reports

  • Write

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

    PUT /crm/v8/settings/automation/webhooks

  • Write

    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 `headers` To retrieve valid module API names, refer to the [Get Modules](modules.yaml#$.paths./settings/modules.get) resource.

    POST /crm/v8/settings/automation/webhooks

  • Write

    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.

    PUT /crm/v8/settings/automation/webhooks/{webhookId}

  • Destructive

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

    DELETE /crm/v8/settings/automation/webhooks

  • Destructive

    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 /crm/v8/settings/automation/webhooks/{webhookId}

Wizards

  • Read

    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 values are create, edit, and create_edit. type represents the action you want to take when the condition is met. The values are set_values, set_lock, show_component, and show_widget. When type=set_lock, the response contains the key exempted_profiles. This array contains the list of profiles that allow edits even after locking specific fields. The color_palette key is added that displays the colors available for a button on a screen. Note that this key is available in the response only if you have chosen at least one custom color for the button on a screen. Changes made to this API from version 5 when you fetch a specific wizard in a layout: - A new JSON array portal_user_types is added to the response that displays the list of portal user types that have access to the wizard. - A new JSON array exempted_portal_user_types is added to the response that represents the list of portal user types that have access to wizards that are blocked for other user types. - Under the segments, for buttons, the Profiles JSON array is added. This indicates the profiles that have access to that button in that screen. - In the Screens JSON array, the "type" of segments JSON object is changed from fields to composite. - In the segments JSON array, the fields JSON array is renamed to elements. - Each object in the elements JSON array contains the sequence number, resource, and type keys. Resource includes the "name" and "id" of the field or the query component on the screen. type indicates whether the resource is a field or query component. From V6, you can get the list of available screens in Wizards. See the sample response for reference.

    GET /crm/v8/settings/wizards

  • Read

    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.

    GET /crm/v8/settings/wizards/{id}

Workflow Configurations

  • Read

    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 sections: triggers (events that fire the rule), actions (operations executed when the rule fires), and related_triggers_details (child/related modules like Notes or Calls that can also trigger rules on the parent module).

    GET /crm/v8/workflow_configurations

Workflow Rules

  • Read

    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 configurations in the response. Results are paginated and can be filtered by module, activation status, trigger type, or rule name.

    GET /crm/v8/settings/automation/workflow_rules

  • Read

    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) operation to obtain the unique ID of the workflow rule to retrieve.

    GET /crm/v8/settings/automation/workflow_rules/{id}

  • Read

    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 /crm/v8/settings/automation/workflow_rules/actions/actions_count

  • Read

    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 /crm/v8/settings/automation/workflow_rules/actions/module_specific_count

  • Read

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

    GET /crm/v8/settings/automation/workflow_rules/actions/rules_count

  • Read

    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.

    GET /crm/v8/settings/automation/workflow_rules/{workflowRuleId}/actions/usage

  • Write

    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.

    POST /crm/v8/settings/automation/workflow_rules

  • Write

    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 — changing from one trigger category to another (for example, from a Record Action trigger to a Score-based trigger) is not supported. The module associated with a workflow rule cannot be changed after creation. To remove an existing condition or action, include it in the request with `_delete` set to `null`. Use the [Get Workflow Rules API](workflow_rules.yaml#$.paths./settings/automation/workflow_rules.get) to retrieve rule IDs before calling this operation.

    PUT /crm/v8/settings/automation/workflow_rules

  • Write

    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 API](workflow_rules.yaml#$.paths./settings/automation/workflow_rules.get) to retrieve available rule IDs. Only include the fields you want to change; existing actions not specified in the request are preserved. To remove an existing condition or action, set its `_delete` key to null. You cannot change the module or trigger module of a workflow rule, and the trigger type cannot be changed across categories.

    PUT /crm/v8/settings/automation/workflow_rules/{id}

  • Write

    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.

    PUT /crm/v8/settings/automation/workflow_rules/actions/reorder

  • Destructive

    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 /crm/v8/settings/automation/workflow_rules

  • Destructive

    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 /crm/v8/settings/automation/workflow_rules/{id}

Automation Tasks

  • Read

    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 filters. Use this before PUT/DELETE to discover task IDs.

    GET /crm/v8/settings/automation/tasks

  • Read

    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 state before updating via PUT.

    GET /crm/v8/settings/automation/tasks/{id}

  • Write

    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 field info. BEHAVIOR: This is a full replacement - all field_mappings must be provided, not just the changed ones. KEY CONSTRAINTS: Locked tasks (locked by workflow rules, approval processes, or blueprints) return 401 AUTHORIZATION_ERROR. Read-only tasks return 400.

    PUT /crm/v8/settings/automation/tasks

  • Write

    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 discover supported fields and identify mandatory fields where required: true in the field info. STRUCTURE: The request body contains a tasks array with exactly 1 task object. Each task requires: name (string), module ({api_name, id}), and field_mappings (array). Omitting mandatory fields returns REQUIRED_DATA_NOT_FOUND. Returns the created task ID.

    POST /crm/v8/settings/automation/tasks

  • Write

    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 field info. BEHAVIOR: This is a full replacement - all field_mappings must be provided, not just the changed ones. KEY CONSTRAINTS: Locked tasks (locked by workflow rules, approval processes, or blueprints) return 401 AUTHORIZATION_ERROR. Read-only tasks return 400.

    PUT /crm/v8/settings/automation/tasks/{id}

  • Destructive

    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. Use GET /settings/automation/tasks to discover task IDs before deleting.

    DELETE /crm/v8/settings/automation/tasks

  • Destructive

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

    DELETE /crm/v8/settings/automation/tasks/{id}

Zia Enrichment Configuration API

  • Read

    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 /crm/v8/settings/zia/data_enrichment

  • Read

    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 /crm/v8/settings/zia/data_enrichment/{id}

  • Write

    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.

    POST /crm/v8/settings/zia/data_enrichment

  • Write

    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.

    PUT /crm/v8/settings/zia/data_enrichment/{id}

  • Destructive

    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 /crm/v8/settings/zia/data_enrichment/{id}

Zia organization enrichment

  • Read

    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.

    GET /crm/v8/__zia_org_enrichment

  • Read

    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.

    GET /crm/v8/__zia_org_enrichment/{id}

  • Write

    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 fields of the target module or record.

    POST /crm/v8/__zia_org_enrichment

See How connections work for access and permissions, or browse all integrations.

Reference date: October 28, 2026. Zoho CRM API docs.