Zoho CRM
API integration

list_all_zoho_crm_modules

List all Zoho CRM modules available in the account settings. Returns: id, api_name, generated_type.

get_single_zoho_crm_module_by_id

Get a single Zoho CRM module by its numeric id. Returns: id, api_name, generated_type. Required: id.

list_all_zoho_crm_users

List users in zohocrm. Returns: id, type. Max 200 users per response.

get_single_zoho_crm_user_by_id

Get a single zohocrm user by id. Returns: id, type. Required: id.

zoho_crm_users_me

Get the current authenticated user in zohocrm. Returns: id, type.

delete_a_zoho_crm_user_by_id

Delete a zohocrm user by id. Returns an empty 204 response on success. Required: id.

create_a_zoho_crm_user

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

update_a_zoho_crm_user_by_id

Update User. Update single user by ID. API exposed to customers

zoho_crm_users_associated_groups

Get the groups associated with a zohocrm user. Returns: id. Required: user.

zoho_crm_users_bulk_update

Update User. Update multiple users. API exposed to customers

zoho_crm_users_transfer

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

zoho_crm_users_transfer_and_delete

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

zoho_crm_users_validate_before_transfer

Validate a zohocrm user before transferring their records to check whether the transfer can proceed. Returns: id, type. Required: id.

zoho_crm_users_bulk_delete

Delete a User. Delete a user by ID. API exposed to customers

list_all_zoho_crm_deals

List all deals in Zoho CRM. Returns deal records including id, Deal_Name, Stage, Amount, Closing_Date, Owner, Account_Name, Probability, Lead_Source, Modified_Time, Created_Time, and additional deal properties. Max 200 records per page.

get_single_zoho_crm_deal_by_id

Get a single Zoho CRM deal by id. Returns the deal record including id, Deal_Name, Stage, Amount, Closing_Date, Owner, Account_Name, Probability, Lead_Source, Modified_Time, Created_Time, and additional deal properties. Required: id.

create_a_zoho_crm_deal

Create a new deal in Zoho CRM. Returns the created deal record including id, Deal_Name, Stage, Amount, Closing_Date, Owner, Account_Name, Created_Time, and other deal properties.

update_a_zoho_crm_deal_by_id

Update an existing Zoho CRM deal by id. Returns the updated deal record including id, Deal_Name, Stage, Amount, Closing_Date, Owner, Account_Name, Modified_Time, and other deal properties. Required: id.

delete_a_zoho_crm_deal_by_id

Delete a Zoho CRM deal by id. Returns an empty 204 response on success. Required: id.

list_all_zoho_crm_fields

List all fields configured for a Zoho CRM module. Returns: id, api_name. Required: module.

get_single_zoho_crm_field_by_id

Get a single field's metadata from a Zoho CRM module by id. Returns: id, api_name. Required: id, module.

create_a_zoho_crm_field

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

update_a_zoho_crm_field_by_id

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

delete_a_zoho_crm_field_by_id

Delete a field from a Zoho CRM module by id. Returns an empty 204 response on success. Required: id, module.

list_all_zoho_crm_deal_notes

List notes associated with a specific deal in Zoho CRM. Returns: id, Note_Title, Note_Content, Owner, Parent_Id, Created_By, Modified_By, Created_Time, Modified_Time, and $se_module for each note. Required: deal_id.

list_all_zoho_crm_deal_attachments

List attachments associated with a specific Deal in zohocrm. Returns: id, File_Name, Size, Owner, Created_By, Modified_By, Created_Time, Modified_Time, and Parent_Id for each attachment record. Required: deal_id.

list_all_zoho_crm_roles

List all roles configured in your Zoho CRM organization. Returns: id.

get_single_zoho_crm_role_by_id

Get a single Zoho CRM role by id. Returns: id. Required: id.

list_all_zoho_crm_notes

List notes in Zoho CRM. Returns: id, Note_Title, Note_Content, Parent_Id, and $attachments per note record. Max 200 records per page.

get_single_zoho_crm_note_by_id

Get a specific Zoho CRM note by id. Returns: id, Note_Title, Note_Content, Parent_Id, and $attachments. Required: id.

delete_a_zoho_crm_note_by_id

Permanently delete a specific Zoho CRM note by id. Returns: code, message, status, and details containing the deleted note's id. Required: id.

create_a_zoho_crm_note

Create one or more notes in Zoho CRM. Returns per-record results including code, status, message, and details with id, Created_Time, Modified_Time, Created_By, and Modified_By. Required: data.

update_a_zoho_crm_note_by_id

Update a specific Zoho CRM note by id. At least one of Note_Title or Note_Content must be supplied in the data payload. Returns: code, status, message, and details with id, Modified_Time, Created_Time, Created_By, and Modified_By. Required: id, data.

zoho_crm_notes_bulk_delete

Delete one or more notes in Zoho CRM associated with a parent record. Returns deletion result objects including code, message, status, and details (containing the deleted note id). Required: parent_record_module, parent_record_id.

zoho_crm_notes_bulk_update

Update one or more notes in Zoho CRM associated with a parent record; at least Note_Title or Note_Content must be provided per note. Returns update result objects including code, message, status, and details (id, Modified_Time, Created_Time, Created_By, Modified_By). Required: parent_record_module, parent_record_id, data.

list_all_zoho_crm_events

List events in Zoho CRM. Returns a collection of event records, each including id, Event_Title, Start_DateTime, End_DateTime, Venue, Owner, Participants, Who_Id, What_Id, Description, Recurring_Activity, Remind_Participants, Check_In_City, Check_In_Status, Latitude, Longitude, Tag, Created_Time, and Modified_Time.

get_single_zoho_crm_event_by_id

Get a single Zoho CRM event by id. Returns: id, Event_Title, Start_DateTime, End_DateTime, Venue, Owner, Participants, Who_Id, What_Id, Description, Recurring_Activity, Remind_Participants, Check_In_City, Check_In_Status, Latitude, Longitude, Tag, Created_By, Created_Time, Modified_By, and Modified_Time. Required: id.

update_a_zoho_crm_event_by_id

Update an existing Zoho CRM event by id. Returns the updated event record including id, Event_Title, Start_DateTime, End_DateTime, Venue, Owner, Participants, Who_Id, What_Id, Description, Recurring_Activity, Remind_Participants, Check_In_City, Check_In_Status, Latitude, Longitude, Tag, and Modified_Time. Required: id.

create_a_zoho_crm_event

Create a new event in Zoho CRM. Returns the created event record including id, Event_Title, Start_DateTime, End_DateTime, Venue, Owner, Participants, Who_Id, What_Id, Description, Recurring_Activity, Remind_Participants, Check_In_City, Check_In_Status, Latitude, Longitude, Tag, and Created_Time.

delete_a_zoho_crm_event_by_id

Delete a Zoho CRM event by id. Returns an empty 204 response on success. Required: id.

zoho_crm_events_cancel

Cancel a ZohoCRM event (meeting) by event ID, optionally sending a cancellation notification email to participants. Returns: code, message, status, and details (including the cancelled event's id). Required: event, and a data array containing send_cancelling_mail.

list_all_zoho_crm_calls

List call records from Zoho CRM. Returns: id, Subject, Call_Type, Call_Start_Time, Call_Duration, Owner, Who_Id, What_Id, Outgoing_Call_Status, Dialled_Number, Created_Time, Modified_Time, Call_Purpose, Description, and Tag.

get_single_zoho_crm_call_by_id

Get a single call record by id from Zoho CRM. Returns: id, Subject, Call_Type, Call_Start_Time, Call_Duration, Owner, Who_Id, What_Id, Outgoing_Call_Status, Dialled_Number, Caller_ID, Created_Time, Modified_Time, Call_Purpose, Description, and other call details. Required: id.

create_a_zoho_crm_call

Create a new call record in Zoho CRM. Returns: code, details, message, and status indicating the outcome of the create operation.

update_a_zoho_crm_call_by_id

Update an existing call record by id in Zoho CRM. Returns: code, details, message, and status indicating the outcome of the update operation. Required: id.

delete_a_zoho_crm_call_by_id

Delete a call record by id from Zoho CRM. Returns: code, details, message, and status indicating the outcome of the delete operation. Required: id.

list_all_zoho_crm_leads

List all lead records in Zoho CRM. Returns lead records including id, Full_Name, Email, Phone, Lead_Status, Company, Owner, Lead_Source, Industry, address fields, and enrichment/conversion metadata.

get_single_zoho_crm_lead_by_id

Get a single Zoho CRM lead by id. Returns the full lead record including id, Full_Name, Email, Phone, Lead_Status, Company, Owner, Lead_Source, Industry, address fields, and enrichment/conversion metadata. Required: id.

create_a_zoho_crm_lead

Create a new lead record in Zoho CRM. Returns the created lead including id, Full_Name, Email, Phone, Lead_Status, Company, Owner, Lead_Source, Industry, address fields, and enrichment metadata.

update_a_zoho_crm_lead_by_id

Update an existing Zoho CRM lead by id. Returns the updated lead record including id, Full_Name, Email, Phone, Lead_Status, Company, Owner, Lead_Source, Industry, address fields, and enrichment metadata. Required: id.

delete_a_zoho_crm_lead_by_id

Delete a Zoho CRM lead by id. Returns an empty 204 response on success. Required: id.

zoho_crm_leads_convert

Convert a Zoho CRM Lead record into Contact, Account, and/or Deal records. Returns the created Contact, Account, and Deal objects including their id and name. Required: id.

zoho_crm_leads_mass_convert

Retrieve the status of a previously scheduled mass lead convert job in Zoho CRM. Returns: Status, Total_Count, Converted_Count, Not_Converted_Count, Failed_Count. Required: job_id.

list_all_zoho_crm_contacts

List contacts in Zoho CRM. Returns: id, First_Name, Last_Name, Email, Phone, Mobile, Account_Name, Owner, Created_Time, Modified_Time, and other contact fields including mailing address, social handles, and enrichment data. Fetches up to 200 records per call.

get_single_zoho_crm_contact_by_id

Get a single Zoho CRM contact by id. Returns: id, First_Name, Last_Name, Email, Phone, Mobile, Account_Name, Owner, Created_Time, Modified_Time, and other contact fields including mailing address, social handles, and enrichment data. Required: id.

create_a_zoho_crm_contact

Create a new contact in Zoho CRM. Returns the created contact record including id, First_Name, Last_Name, Email, Phone, Account_Name, Owner, Created_Time, Modified_Time, and other contact fields.

update_a_zoho_crm_contact_by_id

Update an existing Zoho CRM contact by id. Returns the updated contact record including id, First_Name, Last_Name, Email, Phone, Account_Name, Owner, Modified_Time, and other contact fields. Required: id.

delete_a_zoho_crm_contact_by_id

Delete a Zoho CRM contact by id. Returns an empty 204 response on success. Required: id.

zoho_crm_contacts_merge

Merge Records. Merges duplicate records in Zoho CRM modules with field mapping and validation. Supports synchronous and asynchronous merge operations.

zoho_crm_contacts_batch_delete

Mass delete with record ids and custom view id. Mass delete records with record ids or custom view id

list_all_zoho_crm_tasks

List task records from Zoho CRM. Returns: id, Subject, Status, Priority, Owner, Due_Date, Who_Id, What_Id, Created_Time, Modified_Time, and Description for each task.

get_single_zoho_crm_task_by_id

Get a single Zoho CRM task by id. Returns: id, Subject, Status, Priority, Owner, Due_Date, Who_Id, What_Id, Created_Time, Modified_Time, and Description. Required: id.

create_a_zoho_crm_task

Create a new task record in Zoho CRM. Returns: code, details, message, and status for the operation.

update_a_zoho_crm_task_by_id

Update an existing Zoho CRM task by id. Returns: code, details, message, and status for the operation. Required: id.

delete_a_zoho_crm_task_by_id

Delete a Zoho CRM task by id. Returns: code, details, message, and status for the operation. Required: id.

list_all_zoho_crm_accounts

List all Zoho CRM accounts. Returns a collection of account records including id, Account_Name, Owner, Phone, Industry, Annual_Revenue, Billing_Country, Shipping_Country, Created_Time, Modified_Time, and other address and account metadata fields.

get_single_zoho_crm_account_by_id

Get a single Zoho CRM account by id. Returns the full account record including id, Account_Name, Owner, Phone, Industry, Annual_Revenue, Billing_Country, Shipping_Country, Created_Time, Modified_Time, and other address and account metadata fields. Required: id.

create_a_zoho_crm_account

Create a new account in Zoho CRM. Returns the operation result including code, status, message, and details containing the new record's id and timestamps. Required: Account_Name.

update_a_zoho_crm_account_by_id

Update an existing Zoho CRM account by id. Returns the operation result including code, status, message, and details containing the record's id and Modified_Time. Required: id.

delete_a_zoho_crm_account_by_id

Delete a Zoho CRM account by id. Returns the operation result including code, status, message, and details containing the deleted record's id. Required: id.

zoho_crm_accounts_merge

Merge Records. Merges duplicate records in Zoho CRM modules with field mapping and validation. Supports synchronous and asynchronous merge operations.

zoho_crm_accounts_batch_delete

Mass delete with record ids and custom view id. Mass delete records with record ids or custom view id

list_all_zoho_crm_emails

List emails associated with a Zoho CRM contact record. Returns: id, message_id. Required: contact_id.

get_single_zoho_crm_email_by_id

Get a single email by id for a Zoho CRM contact. Returns: id, message_id. Required: contact_id, id.

create_a_zoho_crm_email

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

zoho_crm_emails_bulk_delete

Unlink a specific email from a Zoho CRM contact record by message ID. Returns: id, message_id. Required: contact_id, message_id.

zoho_crm_emails_link_record

Link Emails to Deals. Links the emails to the specified deals in CRM.

zoho_crm_emails_download_attachments

Download email attachments for a record in a Zoho CRM module. Returns attachment file data; the response shape is content-specific and not enumerated in the zohocrm source documentation for this endpoint. Required: module, record_id.

zoho_crm_emails_download_inline_images

Download inline images from emails for a record in a Zoho CRM module. Returns inline image file data; the response shape is content-specific and not enumerated in the zohocrm source documentation for this endpoint. Required: module, record_id.

list_all_zoho_crm_organization

List organization details for the authenticated zohocrm account. Returns: id, company_name, primary_email, currency, time_zone, country, domain_name, zgid, mc_status, gapps_enabled, and translation_enabled.

list_all_zoho_crm_pipelines

List all pipelines in the Zoho CRM Deals module for a given layout. Returns: id, stages. Required: layout_id.

get_single_zoho_crm_pipeline_by_id

Get a single pipeline in the Zoho CRM Deals module by id. Returns: id, stages. Required: id, layout_id.

list_all_zoho_crm_search

Search records in a Zoho CRM module. Returns matching record objects, each containing id and additional module-specific fields that vary by module (e.g., Leads, Contacts, Deals). Required: module_name.

list_all_zoho_crm_coql

Execute a COQL (CRM Object Query Language) query against Zoho CRM to retrieve records using SQL-like syntax. Returns records including id and query-specific attributes determined by the SELECT clause (supports SELECT, FROM, WHERE, GROUP BY, ORDER BY, JOIN). Required: select_query.

list_all_zoho_crm_campaigns

List campaign records from the Zoho CRM Campaigns module. Returns: id, Campaign_Name, Type, Status, Start_Date, End_Date, Expected_Revenue, Budgeted_Cost, Actual_Cost, Num_sent, Owner, Created_Time, Modified_Time, Description, Parent_Campaign, Created_By, Modified_By.

get_single_zoho_crm_campaign_by_id

Get a single campaign record by id from Zoho CRM. Returns: id, Campaign_Name, Type, Status, Start_Date, End_Date, Expected_Revenue, Budgeted_Cost, Actual_Cost, Num_sent, Owner, Created_Time, Modified_Time, Description, Parent_Campaign, Created_By, Modified_By. Required: id.

list_all_zoho_crm_search_users

Search Zoho CRM users by keyword, email, or user type. Returns a list of matching user records including id, name, email, role, profile, status, created_time, and modified_time.

list_all_zoho_crm_tasks_search

Search Tasks records in Zoho CRM using criteria expressions, keywords, email, or phone filters. Returns: id, Subject, Status, Due_Date, Priority, Owner, Created_Time, Modified_Time per matching task record. At least one of criteria, word, email, or phone should be supplied to filter results.

list_all_zoho_crm_search_accounts

Search ZohoCRM account records using keyword, criteria, or contact detail filters. Returns matching account objects including id, Account_Name, Owner, Phone, Website, Industry, Account_Type, Annual_Revenue, Created_Time, and Modified_Time. At least one of criteria, email, phone, or word must be supplied.

list_all_zoho_crm_search_contacts

Search for contact records in Zoho CRM and retrieve those that match your search criteria. Returns a list of matching contact records. Returns: id.

list_all_zoho_crm_search_deals

Search Deals in Zoho CRM using criteria expressions, keyword, email, or phone. Returns: id, Deal_Name, Stage, Amount, Closing_Date, Account_Name, Owner, Created_Time, and Modified_Time. At least one search parameter (criteria, word, email, or phone) must be supplied.

list_all_zoho_crm_search_leads

Search Lead records in Zoho CRM using criteria expressions, email, phone, or keyword filters. Returns: id, First_Name, Last_Name, Email, Phone, Company, Lead_Status, Lead_Source, Owner, Created_Time, Modified_Time. At least one of criteria, email, phone, or word is typically required to narrow results.

list_all_zoho_crm_layouts

List all layouts configured for the Deals module in Zoho CRM. Returns: id, name, api_name, status, visible, created_time, modified_time, sections, and profiles for each layout.

zoho_crm_misc_add_tags

Associate tags with records in a zohocrm module. Returns the status of each tag association including code, message, and status. Required: module.

zoho_crm_misc_assign_territories

Assign territories to a record in a zohocrm module, scheduling the assignment asynchronously. Returns a scheduled success response including code, message, and status. Required: module, record.

zoho_crm_misc_associate_email

Associate emails with a specific record in a zohocrm module. Returns an action response including code, message, and status. Required: module, record_id.

zoho_crm_misc_attach_attachment

Upload an attachment to a record in a zohocrm module by providing a file or a URL. Returns the upload result including code, message, and status. Required: module_api_name, record_id. Maximum body size 100MB.

zoho_crm_misc_bulk_delete

Bulk delete share access records for a specific record in a zohocrm module. Returns an empty 204 response on success. Required: module_api_name, record_id.

zoho_crm_misc_bulk_update

Update Share Records. Update Share Records. API exposed to customers

zoho_crm_misc_change_owner

Change the owner of a specific record in a zohocrm module. Returns: code, details (containing the updated record's id), message, and status. Required: module, record. Body requires owner with id.

zoho_crm_misc_clone

Clone an existing record in a zohocrm module, optionally overriding specific field values in the copy. Returns: code, details (with the new record's id), message, and status. Required: module, record_id.

zoho_crm_misc_convert

Convert a zohocrm inventory record to another module type (Quotes → Sales Orders or Invoices; Sales Orders → Invoices). Returns: code, message, status, and details containing the target record's id and name. Required: module_api_name, id.

create_a_zoho_crm_misc

Create a new record in a specific zohocrm module. Returns: code, details (with the new record's id), message, and status. Required: module.

zoho_crm_misc_download_mail_merge

Download a merged document for a Zoho CRM record using a mail merge template. Returns: code, message, status. Required: module_api_name, record_id.

zoho_crm_misc_enrol_in_cadences

Enroll Zoho CRM records into a manual cadence for a specified module. Returns: code, message, status per enrolled record. Required: module.

zoho_crm_misc_fetch_full_data

Fetch the full HTML content of rich text fields for multiple Zoho CRM records in a module. Returns id and named rich text field values (HTML, up to 50,000 characters each). Required: module_api_name, fields. Supports a maximum of 8 rich text fields per request.

zoho_crm_misc_get_related_records_count

Retrieve the count of related records for a specific Zoho CRM parent record, with optional filtering by field values, approval status, conversion status, and record categories. Returns: count per requested related list. Required: module_api_name, record_id.

list_all_zoho_crm_misc

Fetch full rich text field data for a specific Zoho CRM record by id within a module. Returns id and named rich text field values. Required: module_api_name, id.

zoho_crm_misc_mass_change_owner

Check the status of a mass change owner job in Zoho CRM. Returns: Status, Updated_Count, Failed_Count, Not_Updated_Count, Total_Count. Required: module, job_id.

zoho_crm_misc_mass_delete

Retrieve the status of a mass delete job in Zoho CRM by job ID. Returns: Status, Total_Count, Deleted_Count, Failed_Count. Required: module, job_id.

zoho_crm_misc_mass_update

Retrieve the current status and progress metrics of a mass update job in Zoho CRM. Returns: Status, Updated_Count, Failed_Count, Not_Updated_Count, Total_Count. Required: module, job_id.

zoho_crm_misc_merge

Retrieve the status of a record merge job in Zoho CRM. Returns: job_id, status. Required: module, master_record_id, job_id.

zoho_crm_misc_portal_invite

Invite portal users for a Zoho CRM module or check the status of a portal invitation job. Returns: code, message, status, details. Required: module.

zoho_crm_misc_remove_tags

Remove tags from records in a Zoho CRM module. Returns operation result data including code, status, message, and details per record. Required: module.

zoho_crm_misc_remove_territories

Remove territories from a record in a Zoho CRM module. The removal is processed asynchronously (202 Accepted) and returns scheduled operation result data including code, status, message, and details. Required: module, record, data.

zoho_crm_misc_send_mail

Send an email using specific templates or custom content to a record in a Zoho CRM module. Returns operation result data including code, status, message, and details. Required: module_name, id.

zoho_crm_misc_send_mail_merge

Send a mail merge email using a Zoho CRM template to a record, with optional inline images or separate file attachments. Returns operation result data including code, status, message, and details. Required: module_api_name, record_id.

zoho_crm_misc_share

Get share records for a Zoho CRM record, listing who it is shared with, by whom, and at what permission level. Returns: shared_with, shared_by, permission, shared_through, shared_time, type, share_related_records. Required: module_api_name, record_id.

zoho_crm_misc_share_emails

Share Emails of a record. To share emails of specific record with other users in your organization

zoho_crm_misc_sign_mail_merge

POST /{module_API_name}/{recordId}/actions/sign_mail_merge. To send a mail merge document for signing and approval.To use this API, you must initially access the Merge and Sign dialogue from the Writer UI once. Please note that you need to do this only once.

zoho_crm_misc_unblock_email

Unblock emails for multiple records in a zohocrm module. Returns: code, details, message, status per record. Required: module, ids, unblock_fields. Maximum 100 record IDs per request.

zoho_crm_misc_unenrol_from_cadences

Unenroll records from cadences. Un-Enroll records from the cadences

zoho_crm_misc_unshare_emails

Unshare Emails of a record. To unshare emails of specific record with other users in your organization

zoho_crm_misc_watch

List all active notification channels in zohocrm. Returns: channel_id, notify_url, channel_expiry, events, resource_id, resource_name, resource_uri, notify_on_related_action, return_affected_field_values, fields, notification_condition, and token.

delete_a_zoho_crm_misc_by_id

Delete a specific related record from a zohocrm module's related list. Returns per-record result including code, message, status, and details containing the deleted record's id. Required: parent_record_module, parent_record, related_list, record.

get_single_zoho_crm_misc_by_id

Get a specific related record from a zohocrm module's related list. Returns the record's id and module-specific field data. Required: parent_record_module, parent_record, related_list, record.

update_a_zoho_crm_misc_by_id

Update notification channel subscriptions in zohocrm. Returns updated channel details including channel_id, notify_url, channel_expiry, events, notify_on_related_action, return_affected_field_values, resource_name, and token.

create_a_zoho_crm_misc_add_tag

POST /{module}/{id}/actions/add_tags. This endpoint is used to add tags to record

list_all_zoho_crm_misc_attachments

List attachments for a specific record in a Zoho CRM module. Returns: id, File_Name, Size, Owner, Created_By, Modified_By, Created_Time, Modified_Time, Parent_Id, Type, $file_id. Required: module_api_name, record_id.

create_a_zoho_crm_misc_change_owner

Change owner for multiple records. Updates the owner of multiple records in the module

create_a_zoho_crm_misc_mass_change_owner

Mass change owner of records. Mass change the owner of records in a module based on a custom view

create_a_zoho_crm_misc_mass_delete

Mass delete with record ids and custom view id. Mass delete records with record ids or custom view id

create_a_zoho_crm_misc_mass_update

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

create_a_zoho_crm_misc_merge

Merge Records. Merges duplicate records in Zoho CRM modules with field mapping and validation. Supports synchronous and asynchronous merge operations.

create_a_zoho_crm_misc_portal_invite

Invite portal users. Send invitations to portal users for a specific module.

create_a_zoho_crm_misc_remove_tag

POST /{module}/{id}/actions/remove_tags. This endpoint is used to dissociate tags from records

create_a_zoho_crm_misc_remove_territory

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

create_a_zoho_crm_misc_share

Create Share Records. Create Share Records. API exposed to customers

create_a_zoho_crm_misc_share_email

Share Emails in Bulk. To share emails of multiple records with other users in your organization

create_a_zoho_crm_misc_unblock_email

Unblock single email. Unblock email for a single record in a module.

create_a_zoho_crm_misc_unshare_email

Unshare Emails in Bulk. To unshare emails of multiple records with other users in your organization

list_all_zoho_crm_settings_modules

List all Zoho CRM modules and their configuration metadata. Returns: id, api_name, module_name, plural_label, singular_label, status, sequence_number, visibility, profiles, deletable, creatable, and editable. Optionally filter by status or feature_name; when both are provided, AND logic applies.

get_single_zoho_crm_settings_module_by_id

Get metadata for a single Zoho CRM module by its identifier. Returns: id, api_name, module_name, plural_label, singular_label, status, sequence_number, visibility, profiles, deletable, creatable, and editable. Required: module_identifier.

create_a_zoho_crm_settings_module

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

update_a_zoho_crm_settings_module_by_id

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

zoho_crm_settings_modules_bulk_update

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

list_all_zoho_crm_apis

List available REST API endpoints accessible to the current user in Zoho CRM, grouped by module and feature. Returns each entry's path and operation_types, where every operation descriptor includes method, oauth_scope, max_credits, and min_credits.

list_all_zoho_crm_appointments_s

List appointment records in zohocrm. Returns: id, attributes (appointment module-specific fields).

get_single_zoho_crm_appointments_by_id

Get a single zohocrm appointment record by id. Returns: id, attributes (appointment module-specific fields). Required: id.

create_a_zoho_crm_appointments

Create appointment records in zohocrm. Returns: code, details, message, status for each record operation. Required: data.

update_a_zoho_crm_appointments_by_id

Update a zohocrm appointment record by id. Returns: code, details, message, status confirming the update. Required: id, data.

delete_a_zoho_crm_appointments_by_id

Delete a zohocrm appointment record by id. Returns: code, details, message, status confirming the deletion. Required: id.

zoho_crm_appointments_s_bulk_update

Bulk update multiple Zoho CRM Appointments module records in a single request. Returns an array of per-record result objects, each including code, details, message, and status. Max 200 records per request.

zoho_crm_appointments_s_bulk_delete

Bulk delete multiple Zoho CRM Appointments module records by their IDs in a single request. Returns an array of per-record result objects, each including code, details, message, and status. Required: ids.

get_single_zoho_crm_automation_assignment_rule_by_id

Get details of a specific zohocrm assignment rule by id. Returns: id. Required: id.

list_all_zoho_crm_automation_assignment_rules

List all assignment rules configured in zohocrm. Returns: id.

list_all_zoho_crm_deleteds

List deleted records from a related list in Zoho CRM, supporting both recycle-bin and permanently deleted records. Returns: id, display_name, type, deleted_time, deleted_by, and created_by. Required: parent_record_module, parent_record, related_list.

list_all_zoho_crm_deleteds_deleted

List deleted records for a specified Zoho CRM module. Returns: id, attributes (module-specific fields of the deleted record, varying by module). Required: module.

create_a_zoho_crm_misc_op

Create a Record in a specific module

delete_a_zoho_crm_misc_op_by_id

Delete related records from a Zoho CRM parent record's related list. Returns an empty 204 response on success. Required: parent_record_module, parent_record, related_list.

get_single_zoho_crm_misc_op_by_id

Get a single record from a Zoho CRM module by record ID. Returns the record object including id and module-specific attributes. Required: module, record_id.

list_all_zoho_crm_misc_ops

List related records from a Zoho CRM parent record's related list. Returns each related record including id and module-specific attributes. Required: parent_record_module, parent_record, related_list.

update_a_zoho_crm_misc_op_by_id

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

zoho_crm_misc_ops_bulk_delete

Delete a specific related record from a Zoho CRM related list, removing the association between a parent record and the specified related record. Required: parent_record_module, parent_record, related_list, record. Returns an empty 204 response on success.

zoho_crm_misc_ops_bulk_update

To update existing entities or records in a specified module. To update existing entities or records in a specified module.

zoho_crm_misc_watch_bulk_delete

Bulk delete watch notification subscriptions in Zoho CRM. Returns the resulting watch array including each record's id.

zoho_crm_misc_watch_bulk_update

Update full notification details. Replace all details of an existing notification channel, overwriting its previous configuration.

create_a_zoho_crm_misc_watch

Create notification channels. Create one or more notification channels.

list_all_zoho_crm_settings_appointment_preferences

Retrieve appointment preferences configured in zohocrm, covering job sheet visibility, booking flexibility, and deal creation rules. Returns: show_job_sheet, when_appointment_completed, allow_booking_outside_service_availability, allow_booking_outside_businesshours, deal_record_configuration, when_duration_exceeds.

zoho_crm_settings_appointment_preferences_bulk_update

Update appointment preferences in zohocrm, configuring job sheet visibility, deal creation behavior on appointment completion, booking flexibility outside service availability and business hours, and deal record field mappings. Returns: show_job_sheet, when_appointment_completed, allow_booking_outside_service_availability, allow_booking_outside_businesshours, deal_record_configuration, when_duration_exceeds.

list_all_zoho_crm_settings_fields

List all custom field metadata for a Zoho CRM module. Returns: id, attributes. Required: module.

get_single_zoho_crm_settings_field_by_id

Get metadata for a specific custom field in a Zoho CRM module by id. Returns: id, attributes. Required: id, module.

create_a_zoho_crm_settings_field

Create one or more custom fields in a Zoho CRM module. Returns: id, attributes for each created field. Required: module, fields (body).

update_a_zoho_crm_settings_field_by_id

Update a custom field in a Zoho CRM module by id. Returns: id, attributes of the updated field. Required: id, module, fields (body).

delete_a_zoho_crm_settings_field_by_id

Delete a custom field from a Zoho CRM module by id. The field must not be in use by workflows, approvals, scoring rules, or other configurations. Returns: id, attributes of the deleted field. Required: id, module.

zoho_crm_settings_fields_bulk_update

Bulk update custom fields in a Zoho CRM module. Returns: code, message, status, and details for each updated field. Required: module.

list_all_zoho_crm_settings_layouts

List all layout metadata for a module in Zoho CRM. Returns layout configuration including id, name, status, sections, and profiles for all layouts in the specified module without pagination. Required: module.

get_single_zoho_crm_settings_layout_by_id

Get a specific layout by id in Zoho CRM. Returns layout configuration including id, name, status, sections, and profiles. Required: id, module.

update_a_zoho_crm_settings_layout_by_id

Update a custom layout in Zoho CRM. Modify the layout name, profile permissions, sections, and fields within sections. Returns: code, details, message, status. Required: id, module. Maximum 5 sections and 5 fields total across all sections per request.

delete_a_zoho_crm_settings_layout_by_id

Delete a custom layout from a module in Zoho CRM. Specify transfer_to to transfer records when the layout has associated records. Returns: code, details, message, status. Required: id, module.

zoho_crm_settings_layouts_activate

Activate a deactivated layout in Zoho CRM, making it available for use in the specified module. Optionally add or remove profile associations during activation. Returns: code, details, message, status. Required: id, module.

zoho_crm_settings_layouts_bulk_delete

Bulk delete Zoho CRM settings layouts by issuing a DELETE against the activate action endpoint. Returns an empty 204 response on success. Required: id.

create_a_zoho_crm_upsert

Insert or update records in a zohocrm module using the Upsert API, matching on duplicate_check_fields to determine whether to create or update each existing record. Returns: code, message, status, and details (including the record id and action taken). Required: module, data. Supports up to 100 records per request.

list_all_zoho_crm_users_transfer

List the status of 'transfer records and delete user' jobs previously scheduled in Zoho CRM. Returns user transfer job records including id, name, email, and status for each job entry.

create_a_zoho_crm_users_transfer_and_delete

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

list_all_zoho_crm_users_transfer_and_delete

List Zoho CRM user records associated with the transfer_and_delete action endpoint. Returns user status objects including id and attributes.

create_a_zoho_crm_users_user

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

delete_a_zoho_crm_users_user_by_id

Delete a user from your zohocrm organization by user ID. Returns an empty 204 response on success. Required: user.

get_single_zoho_crm_users_user_by_id

Get a single zohocrm user by user ID. Returns: id. Required: user.

list_all_zoho_crm_users_users

List users in your zohocrm organization. Returns: id.

update_a_zoho_crm_users_user_by_id

Update User. Update single user by ID. API exposed to customers

zoho_crm_users_users_bulk_update

Bulk update multiple Zoho CRM users in a single request by providing an array of user objects, each identified by their id. Returns: code, details, message, status for each update operation in the request. Required: users array where each entry must include id.

create_a_zoho_crm_composite_request

Execute up to 5 Zoho CRM API sub-requests in a single HTTP call. Returns an array of per-sub-request results each containing code, message, status, and details (with the sub-response headers, body, and status_code). Required: __composite_requests (each item requires method and uri). rollback_on_fail and parallel_execution cannot both be true.

list_all_zoho_crm_conversion_options

List available conversion options for a Zoho CRM lead before performing the actual conversion. Returns: Contacts (matching contact records), Accounts (matching account records), module_preference, preference_field_matched_value (field mappings), and modules_with_multiple_layouts. Required: lead_id.

get_single_zoho_crm_attachment_by_id

Download a specific attachment file from zohocrm by id. Returns the raw binary file content (image, PDF, document, etc.) as an opaque binary stream; link attachments cannot be downloaded and return an error instead. Required: module_api_name, record_id, id.

delete_a_zoho_crm_attachment_by_id

Delete a link attachment associated with a specific record in zohocrm. Returns: code, details (containing the deleted attachment id), message, and status confirming the deletion result. Required: module_api_name, record_id, id.

list_all_zoho_crm_automation_cadences

List all automation cadences configured in zohocrm. Returns: id, name, status, active, published, type, module, created_time, modified_time, created_by, modified_by, execution_details, and custom_view. Optionally filter results by module, name, or active status.

list_all_zoho_crm_contact_roles

List contact roles associated with a specific deal in Zoho CRM. Returns: Owner (name, id, email), Department, Contact_Role (name, id). Required: module, deal_id. Max 100 records per page.

zoho_crm_contact_roles_bulk_update

Add or update contact roles for a specific deal in Zoho CRM in bulk. Returns: Owner, Department, Contact_Role for each processed contact. Required: module, deal_id.

zoho_crm_contact_roles_bulk_delete

Remove contact roles from a specific deal in Zoho CRM in bulk. Returns an empty 204 response on success. Required: module, deal_id.

get_single_zoho_crm_contact_role_by_id

Get the contact role for a specific contact associated with a deal in Zoho CRM. Returns: Owner (name, id, email), Department, Contact_Role (name, id). Required: module, deal_id, contact_id.

update_a_zoho_crm_contact_role_by_id

Update the contact role for a specific contact associated with a deal in Zoho CRM. Returns: Owner, Department, Contact_Role. Required: module, deal_id, contact_id.

delete_a_zoho_crm_contact_role_by_id

Delete a single contact role association from a deal in Zoho CRM by contact ID. Returns: code, status, message, details. Required: module, deal_id, contact_id.

list_all_zoho_crm_contacts_roles

List all contact roles in Zoho CRM. Returns: id, name, sequence_number. Up to 100 roles per response.

create_a_zoho_crm_contacts_role

Create one or more contact roles in Zoho CRM. Returns: code, details (id of created role), message, and status for each role in the batch. Required: contact_roles. Max 100 roles per request.

zoho_crm_contacts_roles_bulk_update

Update one or more existing contact roles in Zoho CRM. Returns: code, details (id of updated role), message, and status for each role in the batch. Required: contact_roles. Max 100 roles per request.

zoho_crm_contacts_roles_bulk_delete

Delete one or more contact roles in Zoho CRM. Returns: code, details (id of deleted role), message, and status for each role in the batch. Required: contact_roles.

get_single_zoho_crm_contacts_role_by_id

Get a single contact role by its ID in Zoho CRM. Returns: id, name, sequence_number. Required: role.

update_a_zoho_crm_contacts_role_by_id

Update a contact role in Zoho CRM by its role ID. Returns: code, details (containing the updated role id), message, and status. Required: role and a contact_roles array in the request body where each item requires name and id.

delete_a_zoho_crm_contacts_role_by_id

Delete a contact role in Zoho CRM by its role ID. Returns: code, details (containing the deleted role id), message, and status for the deletion result. Required: role.

create_a_zoho_crm_coql

Execute a COQL (CRM Object Query Language) select query in Zoho CRM to fetch matching records from any module. Returns record objects whose top-level field keys correspond to the Zoho CRM field API names specified in the SELECT clause — the exact schema is query-specific and cannot be enumerated statically. Required: select_query. Max 200 records per response.

create_a_zoho_crm_leads_mass_convert

Mass convert up to 50 Zoho CRM leads to Contacts, Accounts, and optionally Deals in a single API call. Returns: id, status. Required: Leads. Maximum 50 leads per request.

list_all_zoho_crm_org_currencies

List all currencies configured in the zohocrm organization. Returns: id, iso_code, name, symbol, exchange_rate, is_active, is_base, prefix_symbol, format, created_time, modified_time.

create_a_zoho_crm_org_currency

Create one or more new currencies in the zohocrm organization. Returns: code, status, message, details (with the new currency's id). Required: currencies (array; each item requires exchange_rate and iso_code).

get_single_zoho_crm_org_currency_by_id

Get a single currency from the zohocrm organization by its identifier. Returns: id, iso_code, name, symbol, exchange_rate, is_active, is_base, prefix_symbol, format, created_time, modified_time. Required: currency.

update_a_zoho_crm_org_currency_by_id

Update one or more non-base currencies in the zohocrm organization. Returns: code, status, message, details (with the updated currency's id). Required: currency (path), currencies (body array; each item requires id).

zoho_crm_org_currencies_enable

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

zoho_crm_org_currencies_bulk_update

Update the base currency settings in Zoho CRM via the bulk update action on the currencies enable endpoint. Returns the updated base currency object including id, iso_code, symbol, exchange_rate, and is_active.

zoho_crm_org_currencies_org_bulk_update

Bulk update org currency configurations in zohocrm by sending an array of currency update objects. Returns: id, iso_code, symbol, name, exchange_rate, is_active, is_home_currency. Required: currencies.

list_all_zoho_crm_org_currencies_org

List all currencies configured for the zohocrm org. Returns: id, iso_code, symbol, name, exchange_rate, is_active, is_home_currency, prefix_symbol, created_time, modified_time.

create_a_zoho_crm_read

Create a bulk read job in Zoho CRM to asynchronously export records from a specified module. Returns: status, code, message, and details (including id, operation, state, created_by, and created_time of the queued job). Required: query (with module.api_name).

get_single_zoho_crm_read_by_id

Get a Zoho CRM bulk read job by id to check its processing status. Returns the job object including id, operation, state, created_by, and created_time. Required: id.

list_all_zoho_crm_results

Download the result of a ZohoCRM bulk read job identified by its job ID. Returns: file (the bulk read result delivered as a ZIP file object). Required: job_id.

list_all_zoho_crm_settings_audit_log_exports

List all audit log export jobs in Zoho CRM. Returns: id, status, criteria, created_by, download_links, job_start_time, job_end_time, expiry_date.

create_a_zoho_crm_settings_audit_log_export

Create a new audit log export job in Zoho CRM based on specified filter criteria. Returns: code, details (including the new job id), message, status. Required: audit_log_export.

get_single_zoho_crm_settings_audit_log_export_by_id

Get a specific Zoho CRM audit log export job by its ID. Returns: id, status, criteria, created_by, download_links, job_start_time, job_end_time, expiry_date. Required: id.

list_all_zoho_crm_settings_business_hours

Retrieve the zohocrm organization's business hours configuration including working days, hours, and timezone. Returns: id, type, timezone, week_starts_on, business_days, same_as_everyday, daily_timing, custom_timing.

create_a_zoho_crm_settings_business_hour

Create a new business hours configuration in zohocrm for the organization, specifying working days, hours, and timezone. Returns: id, type, timezone, week_starts_on, business_days, same_as_everyday, daily_timing, custom_timing. Required: business_hours (containing week_starts_on and type).

zoho_crm_settings_business_hours_bulk_update

Update the existing business hours configuration in zohocrm for the organization. Returns: id, type, timezone, week_starts_on, business_days, same_as_everyday, daily_timing, custom_timing. Required: business_hours (containing week_starts_on and type).

list_all_zoho_crm_settings_call_preferences

Get the call preferences settings for the current user in Zoho CRM, which determine whether the from-number and to-number fields are displayed during CRM calls. Returns: show_from_number, show_to_number.

zoho_crm_settings_call_preferences_bulk_update

Update call preferences settings in Zoho CRM to control the visibility of the from-number and to-number fields displayed during CRM calls. Returns: show_from_number, show_to_number.

list_all_zoho_crm_settings_custom_views

List all zohocrm custom views for a module. Returns: id, display_value, access_type, category, system_defined, default, module, created_by, modified_by.

get_single_zoho_crm_settings_custom_view_by_id

Get a specific zohocrm custom view by id. Returns: id, display_value, access_type, category, system_defined, default, module, created_by, modified_by. Required: id.

zoho_crm_settings_custom_views_change_sort

Change the sort order of one or more zohocrm custom views in a module. Returns: code, status, message, details. Required: custom_views.

zoho_crm_settings_custom_views_bulk_update

Change the sort order of a specific zohocrm custom view identified by id. Returns: code, status, message, details. Required: id.

list_all_zoho_crm_settings_data_sharings

List the default data sharing settings configured for all modules in Zoho CRM. Returns: share_type, public_in_portals, module (with api_name and id), and rule_computation_running for each module.

zoho_crm_settings_data_sharings_bulk_update

Update the default organization data sharing permissions for modules in Zoho CRM. Returns the updated settings including share_type, public_in_portals, module, and rule_computation_running. Required: data_sharing.

create_a_zoho_crm_write

Create a new bulk write job in zohocrm to insert, update, or upsert CRM records in bulk. Returns: id, created_by. Required: operation, resource.

get_single_zoho_crm_write_by_id

Get the details of a zohocrm bulk write job by id, including overall job status, per-resource processing outcomes, field mappings, and result download link. Returns: id, status, operation, created_time, created_by, resource, result, callback, character_encoding. Required: id.

list_all_zoho_crm_email_drafts

List email drafts associated with a zohocrm record. Returns: id, from, subject, to, cc, bcc, created_time, modified_time, owner, content, rich_text, schedule_details, attachments, and inventory_details for each draft. Required: module, record.

get_single_zoho_crm_email_draft_by_id

Get a single email draft by draft id for a zohocrm record. Returns: id, from, subject, to, cc, bcc, created_time, modified_time, owner, content, rich_text, reply_to, schedule_details, attachments, and inventory_details. Required: module, record, draft.

create_a_zoho_crm_email_draft

Create one or more email drafts for a zohocrm record. Returns: id, from, subject, to, cc, bcc, created_time, modified_time, owner, content, rich_text, schedule_details, attachments, and inventory_details for each created draft. Required: module, record.

update_a_zoho_crm_email_draft_by_id

Update an existing email draft for a zohocrm record. Returns: id, from, subject, to, cc, bcc, modified_time, created_time, owner, content, rich_text, schedule_details, attachments, and inventory_details. Required: module, record, draft.

delete_a_zoho_crm_email_draft_by_id

Delete an email draft from a zohocrm record by draft id. Returns an empty 204 response on success. Required: module, record, draft.

zoho_crm_email_drafts_bulk_update

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

zoho_crm_email_drafts_bulk_delete

Bulk delete email drafts associated with a specific record in a zohocrm module. Returns: code, message, status, details for each draft deletion result. Required: module, record.

list_all_zoho_crm_emails_sharing_details

List email sharing details for a specific zohocrm record. Returns the users with whom the record's emails can be shared and the available email filter types. Returns: shared_from_users, available_types. Required: module_api_name, id.

list_all_zoho_crm_features

List available features and their limits for the current Zoho CRM edition. Returns: api_name, feature_label, module_supported, parent_feature, details (with available_count, limits, and used_count), and components.

get_single_zoho_crm_feature_by_id

Get a single Zoho CRM feature by its API name. Returns: api_name, feature_label, module_supported, parent_feature, details (with available_count, limits, and used_count), and components. Required: feature.

list_all_zoho_crm_automation_field_updates

List all automation field update actions in Zoho CRM. Returns a collection of field update records including id and attributes.

get_single_zoho_crm_automation_field_update_by_id

Get a single automation field update action by id in Zoho CRM. Returns the field update record including id and attributes. Required: id, include_inner_details.

create_a_zoho_crm_automation_field_update

Create a new automation field update action in Zoho CRM that modifies field values when triggered by workflows, blueprints, or approval processes. Returns the created record including id and attributes. Required: field_updates.

update_a_zoho_crm_automation_field_update_by_id

Update an existing automation field update action in Zoho CRM. Returns the updated record including id and attributes. Required: id, field_updates.

delete_a_zoho_crm_automation_field_update_by_id

Delete an automation field update action by id in Zoho CRM. Returns the deletion result including id and attributes on success. Required: id.

zoho_crm_automation_field_updates_bulk_delete

Delete multiple zohocrm automation field update actions in bulk by their IDs. Returns: code, status, message, and details for each deletion result. Required: ids.

zoho_crm_emails_link_record_bulk_delete

Unlink deal associations from email records of a Contact in zohocrm. Required: contact_id. Returns an empty 204 response on success.

list_all_zoho_crm_files

Retrieve binary file content from Zoho CRM's Zoho File System (ZFS) by its unique file ID. Returns the file as binary content (application/octet-stream) with Content-Type and Content-Disposition headers indicating the MIME type and filename. If the file ID does not match any stored file, a 204 No Content response is returned. Required: id.

create_a_zoho_crm_file

Upload one or more files to Zoho CRM's Zoho File System (ZFS) using multipart/form-data. Returns an array of upload results per file, each containing status, code, message, and details (including the file's id and name) needed to associate the uploaded file with CRM records. Required: file. Up to 10 files per request; maximum 20 MB per file.

list_all_zoho_crm_locking_information_s

List locking information records for a zohocrm module record. Returns: id, Locked_By__s, Locked_For__s, Locked_Reason__s, Lock_Source__s, Locked_Time__s, Record_Locking_Configuration_Id__s, $editable, Feature_Type__s. Required: module_name, record_id.

create_a_zoho_crm_locking_information

Lock a zohocrm module record by creating locking information. Returns: status, code, message, details (including id, Created_Time, Modified_Time, Modified_By, and Created_By). Required: module_name, record_id, data.

update_a_zoho_crm_locking_information_by_id

Update the locking reason of a locked zohocrm record. Returns: status, code, message, details (including id, Created_Time, Modified_Time, Modified_By, Created_By). Required: module_name, record_id, lock_id, data.

delete_a_zoho_crm_locking_information_by_id

Delete locking information for a zohocrm record, effectively unlocking it. Returns an empty 204 response on success. Required: module_name, record_id, lock_id.

zoho_crm_locking_information_s_bulk_update

Bulk update locking information for multiple locks on a zohocrm module record in a single request. Returns: status, code, message, details (including id, Created_Time, Modified_Time, Modified_By). Required: module_name, record_id, data.

zoho_crm_locking_information_s_bulk_delete

Bulk delete locking information records associated with a specific zohocrm module record. Returns an empty 204 response on success. Required: module_name, record_id.

list_all_zoho_crm_settings_duplicate_check_preferences

Get the duplicate check preference configuration for a zohocrm module. Returns the preference configuration object including schema-specific configuration fields (attributes); see the GetDuplicateCheckPreference schema in the Zoho CRM v8 API docs for field-level details. Required: module.

create_a_zoho_crm_settings_duplicate_check_preference

Create duplicate check preference settings for a zohocrm module. Returns: code, status, message, details. Required: module.

zoho_crm_settings_duplicate_check_preferences_bulk_update

Update duplicate check preference settings for a zohocrm module. Returns: code, status, message, details.

zoho_crm_settings_duplicate_check_preferences_bulk_delete

Delete duplicate check preference settings for a zohocrm module. Returns: code, status, message, details.

list_all_zoho_crm_settings_email_templates

List email templates in Zoho CRM with support for module-based filtering, category views, advanced filters, and sorting. Returns: id, name, subject, module, created_time, modified_time. Use module to filter by CRM module, category_view for category-based grouping, sort_by and sort_order to control ordering, and filters for advanced criteria.

zoho_crm_settings_emails_from_addresses

Get the list of email addresses that can be used as senders in Zoho CRM. Returns: email, type, user_name, id, and default flag for each address.

list_all_zoho_crm_settings_fiscal_years

Retrieve the fiscal year settings configured for the Zoho CRM organization. Returns: start_month, end_month, is_default.

zoho_crm_settings_fiscal_years_bulk_update

Update the fiscal year settings for the Zoho CRM organization. Returns: start_month, end_month, is_default. Required: fiscal_year.

list_all_zoho_crm_settings_global_picklists

List all zohocrm global picklists available in the organization. Returns: id, display_label, api_name, source, created_time, modified_time, actual_label, customizable, presence, and pick_list_values_sorted_lexically. Use the include parameter to additionally fetch pick_list_values, used_in_modules, and associated_fields_count.

get_single_zoho_crm_settings_global_picklist_by_id

Get a single zohocrm global picklist by id, with pick_list_values included by default. Returns: id, display_label, api_name, source, actual_label, description, created_time, modified_time, customizable, presence, pick_list_values_sorted_lexically, created_by, modified_by, and pick_list_values. Required: id.

create_a_zoho_crm_settings_global_picklist

Create a new zohocrm global picklist with a display label and picklist values. Returns: code, status, message, and details containing the new id. Required: global_picklists array, each item requiring display_label and pick_list_values.

update_a_zoho_crm_settings_global_picklist_by_id

Update a zohocrm global picklist by id. Supports modifying display_label, api_name, description, pick_list_values_sorted_lexically, and pick_list_values (add, update, or delete — only one value may be moved to unused or deleted per request). Returns: code, status, message, details. Required: id, global_picklists.

delete_a_zoho_crm_settings_global_picklist_by_id

Delete a zohocrm global picklist by id. Returns an empty 204 response on success. Required: id.

zoho_crm_settings_global_picklists_replace_picklist_values

Schedule or execute replacement of picklist values for a zohocrm global picklist. Completes immediately (200) when the picklist has no field associations; otherwise schedules asynchronously (202). Returns: code, message, status, details (containing job_id when scheduled). Required: id, replace_picklist_values.

zoho_crm_settings_global_picklists_replaced_values

Get picklist values currently in progress under a replace scheduler for a zohocrm global picklist. Returns: display_value, reference_value per in-progress value. Returns 204 with no content if no replacement scheduler is currently active. Required: id.

zoho_crm_settings_global_picklists_associations

Retrieve field, module, and layout associations for a zohocrm global picklist. Returns: field (api_name, id, field_label), module (api_name, id, plural_label, module_name), layouts (name, id, status). Returns 204 if no picklist fields are associated. Required: id.

zoho_crm_settings_global_picklists_pick_list_values_associations

List features (blueprints, workflows, orchestrations, ABM, etc.) that use a specific picklist value within a zohocrm global picklist. Returns: type (association category), resources (name, id, details). Returns 204 if the picklist value is not associated with any features. Required: id, picklist_value_id.

list_all_zoho_crm_settings_holidays

List holidays in zohocrm, optionally filtered by year, type, or shift ID. Returns: id, name, date, type, shift_hour, year for each matching holiday.

get_single_zoho_crm_settings_holiday_by_id

Get complete details of a specific zohocrm holiday by id. Returns: id, name, date, type, shift_hour, year. Required: id.

create_a_zoho_crm_settings_holiday

Create one or more holidays in zohocrm with specified names, dates, types, and shift associations. Returns: code, status, message, and details (containing the new holiday id) for each created entry. Required: holidays.

update_a_zoho_crm_settings_holiday_by_id

Update the name and/or date of a specific zohocrm holiday. Returns: code, status, message, and details containing the holiday id. Required: id, holidays.

delete_a_zoho_crm_settings_holiday_by_id

Permanently delete a specific zohocrm holiday by id. Returns: code, status, message, and details containing the holiday id. Required: id.

zoho_crm_settings_holidays_bulk_update

Update one or more existing holidays in bulk in zohocrm by supplying an array of holiday objects with their IDs and updated values. Returns: code, details (containing id), message, and status for each holiday in the request. Required: holidays array where each item must include id, name, date, type, and shift_hour. Max 100 holidays per request.

list_all_zoho_crm_settings_inventory_templates

List inventory templates in zohocrm with support for sorting and filtering. Returns: id, name, modified_time, category. Optionally filter by category (normal or draft), sort by any field using sort_by and sort_order, or apply JSON-stringified filter expressions via filters.

create_a_zoho_crm_action_transfer

Transfer zohocrm portal users from one user group to another within the same portal. Returns: code, details (containing personality_id), message, and status for each transferred user. Required: portal, user_type, transfer_To, personality_ids.

list_all_zoho_crm_field_pick_list_values

List the available pick list values for a specified field in zohocrm. Returns: id, display_value, reference_value, actual_value, sequence_number, colour_code, type, and layout_associations for each value. Required: field_id. Returns 204 (no items) if the field exists but is not a pick list type.

list_all_zoho_crm_layout_map_dependencies

List all field dependencies for a specific layout in Zoho CRM, including parent and child field relationships and their metadata. Returns: id, parent, child, sub_module, internal, active, source, category for each dependency record. Required: layout_id.

get_single_zoho_crm_layout_map_dependency_by_id

Get a single field dependency by dependency_id for a specific layout in Zoho CRM. Returns: id, parent, child, sub_module, internal, active, source, category. Required: layout_id, dependency_id.

create_a_zoho_crm_layout_map_dependency

Create a new field dependency mapping between parent and child picklist fields on a layout in Zoho CRM. Returns: code, status, message, details for the operation result. Required: layout_id, map_dependency (with parent, child, and pick_list_values per item). Only one dependency can be created per request.

update_a_zoho_crm_layout_map_dependency_by_id

Update picklist value mappings for an existing field dependency on a layout in Zoho CRM. Use "_delete": null on a mapping entry to remove it. Returns: code, status, message, details. Required: layout_id, dependency_id, map_dependency (with parent, child, and pick_list_values per item).

delete_a_zoho_crm_layout_map_dependency_by_id

Delete an existing field dependency from a layout in Zoho CRM, permanently removing the parent-child picklist field mapping. Returns: code, status, message, details for the operation result. Required: layout_id, dependency_id.

zoho_crm_layout_map_dependencies_bulk_update

Create a new field dependency for a layout. Creates a new field dependency mapping between parent and child fields in a specific layout. The dependency defines how child field values are controlled based on parent field selections.

zoho_crm_layout_map_dependencies_bulk_delete

Delete multiple picklist field dependency mappings on a zohocrm layout in bulk. Returns: code, details, message, status for each deleted dependency. Required: layout_id.

list_all_zoho_crm_notes_notes

List notes in zohocrm associated with a parent module record. Returns: id. Required: parent_record_module, parent_record_id.

get_single_zoho_crm_notes_note_by_id

Get a single zohocrm note by id from a parent module record. Returns: id. Required: parent_record_module, parent_record_id, id.

create_a_zoho_crm_notes_note

Create Notes for a Record. 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).

update_a_zoho_crm_notes_note_by_id

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

delete_a_zoho_crm_notes_note_by_id

Delete a zohocrm note by id from a parent module record. Returns: id. Required: parent_record_module, parent_record_id, id.

zoho_crm_notes_notes_bulk_update

Update multiple zohocrm notes in a single request. Provide an array of note objects under the `data` key, each requiring an `id` plus the fields to change. Returns per-record operation status including code, status, message, and details. Required: data.

zoho_crm_notes_notes_bulk_delete

Delete multiple zohocrm notes in a single request by specifying their IDs. Returns per-record operation status including code, status, message, and details. Required: ids.

list_all_zoho_crm_org_photos

Retrieve the zohocrm organization photo. Returns the photo as binary PNG image data (image/png content type). If no photo has been set for the organization, the API returns 204 No Content instead of image data.

create_a_zoho_crm_org_photo

Upload a photo for the zohocrm organization. Returns: status, code, message, and details confirming the result of the upload operation. Required: file.

zoho_crm_org_photos_bulk_delete

Delete the zohocrm organization photo (logo). Returns an empty 204 response on success.

list_all_zoho_crm_orgs

List Zoho CRM organization details for the authenticated account. Returns the company profile including id, company_name, phone, website, city, country, time_zone, created_time, and additional organizational attributes. No required parameters; the array contains at most one record.

list_all_zoho_crm_portal_user_types

List all portal user types for a Zoho CRM portal. Returns: id, name, active, default, personality_module, modules, active_user_count, deactive_user_count, invitation_field, created_by, created_time, modified_by, modified_time. Required: portal.

get_single_zoho_crm_portal_user_type_by_id

Get a single portal user type by id in Zoho CRM. Returns: id, name, active, default, personality_module, modules, invitation_field, active_user_count, deactive_user_count, created_by, created_time, modified_by, modified_time. Required: portal, user_type_id.

create_a_zoho_crm_portal_user_type

Create portal user type. Create one or more portal user types for the specified portal. Request body must include a user_type array with one or more user type objects.

update_a_zoho_crm_portal_user_type_by_id

Update portal user type. Update the specified portal user type. Request body must include user_type array with items containing the fields to update.

delete_a_zoho_crm_portal_user_type_by_id

Delete a portal user type by id from a Zoho CRM portal. Returns an empty 204 response on success. Required: portal, user_type_id.

zoho_crm_portal_user_types_bulk_update

Create portal user type. Create one or more portal user types for the specified portal. Request body must include a user_type array with one or more user type objects.

zoho_crm_portal_user_types_bulk_delete

Bulk delete portal user types in Zoho CRM from the specified portal. Returns: id, name, modules. Required: portal.

list_all_zoho_crm_searches

Search records in a Zoho CRM module by criteria, word, email, or phone. Returns: id, Owner, Created_Time, Modified_Time, Created_By, Modified_By. Required: module. At least one of criteria, word, email, or phone must also be supplied. Max 2,000 records and 15 criteria conditions; newly created records may have indexing delays.

list_all_zoho_crm_settings_pipelines

List Zoho CRM pipelines configured for a given layout. Returns a collection of pipeline objects; each record includes id. Optional: layout_id.

get_single_zoho_crm_settings_pipeline_by_id

Get a specific Zoho CRM pipeline by id. Returns the pipeline object including id. Required: id.

create_a_zoho_crm_settings_pipeline

Create a new Zoho CRM pipeline for a given layout. Returns: code, details, message, status. Optional: layout_id.

update_a_zoho_crm_settings_pipeline_by_id

Update a Zoho CRM pipeline by id. Returns: code, details, message, status. Required: id. Optional: layout_id.

zoho_crm_settings_pipelines_partial_update

Partially update a Zoho CRM pipeline by id. Returns: code, details, message, status. Required: id.

zoho_crm_settings_pipelines_bulk_update

Update or delete pipeline settings in zohocrm in bulk for a specified layout. Returns operation results per pipeline including code, details, message, and status. Required: layout_id, pipeline.

zoho_crm_settings_pipelines_transfer

Transfer records from one or more pipelines to a target pipeline and delete the source pipelines in zohocrm. Returns transfer operation results per pipeline including code, details, message, and status. Required: layout_id, pipeline.

zoho_crm_settings_pipelines_pipeline_partial_update

Update a pipeline in the Zoho CRM Deals module. Returns the updated pipeline including its id, name, default flag, stages, and layout. Required: pipeline body array containing the id of the pipeline to update.

get_single_zoho_crm_settings_portal_by_id

Get a specific zohocrm portal by its identifier. Returns: name, saml_configuration. Required: portal.

update_a_zoho_crm_settings_portal_by_id

Update settings for a specific zohocrm portal, including its name and SAML configuration. Returns: code, message, details, status. Required: portal, portals.

delete_a_zoho_crm_settings_portal_by_id

Delete a specific zohocrm portal by its identifier. Returns: code, message, details, status. Required: portal.

list_all_zoho_crm_settings_portals

List all zohocrm portals configured in the organization. Returns: name, saml_configuration.

create_a_zoho_crm_settings_portal

Create a new zohocrm portal with a name and optional SAML configuration. Returns: code, message, details, status. Required: portals.

zoho_crm_settings_portals_bulk_update

Update multiple Zoho CRM portals in a single request. Returns updated portal records including name, id, and url. Required: portals.

zoho_crm_settings_portals_bulk_delete

Delete multiple Zoho CRM portals in a single request. Returns the deleted portal records including name, id, and url. Required: portals.

list_all_zoho_crm_settings_tags

List tags in Zoho CRM, optionally filtered by module. Returns tag records including id, name, and color_code.

update_a_zoho_crm_settings_tag_by_id

Update the details of an existing tag in Zoho CRM by id. Returns the updated tag record including id, name, and color_code. Required: id, tags.

delete_a_zoho_crm_settings_tag_by_id

Delete a tag in Zoho CRM by id. Returns the deleted tag record including id, name, and color_code. Required: id.

zoho_crm_settings_tags_bulk_update

Bulk update multiple tags in Zoho CRM in a single request, with tag ids supplied in the request body. Returns the updated tag records including id, name, and color_code. Required: tags.

create_a_zoho_crm_settings_tag

Create one or more tags in Zoho CRM. Returns the created tag records including id, name, and color_code. Required: tags.

zoho_crm_settings_tags_mass_delete

Retrieve the status of scheduled mass delete jobs for Zoho CRM settings tags. Returns a list of jobs, each including job_id, status, and created_time.

zoho_crm_settings_tags_merge

Merge two Zoho CRM settings tags, combining records from the source tag into a target tag. Returns: id. Required: id.

zoho_crm_settings_tags_records_count

Get the number of records associated with a Zoho CRM settings tag by id. Returns: count. Required: id.

create_a_zoho_crm_settings_tags_setting

Create one or more tags for a specific module in Zoho CRM. Returns: code, details (including id, name, and module), message, and status for each created tag. Required: module (query), tags array with name (body).

list_all_zoho_crm_user_type_users

List Zoho CRM portal users filtered by portal and user type. Returns: personality_id, name, email, active, confirm, status_reason__s, created_time, module, Source__s. Required: portal, user_type.

create_a_zoho_crm_user_type_user

Change status of portal users in bulk. Changing portal users status in bulk.

zoho_crm_user_type_users_bulk_delete

Bulk delete users from a Zoho CRM portal for a given user type. Returns: personality_id, name, email, active, confirm, status_reason__s, created_time, module, Source__s. Required: portal, user_type.

zoho_crm_user_type_users_change_status

Change the status of a specific Zoho CRM portal user identified by record_id within a given portal and user type. Returns: personality_id, name, email, active, confirm, status_reason__s, created_time, module, Source__s. Required: portal, user_type, record_id.

list_all_zoho_crm_automation_scoring_rules

List all scoring rules configured in Zoho CRM, optionally filtered by module, layout_id, or name. Returns: id, name, description, module, layout, field_rules, touch_point_rules, custom_fields.

get_single_zoho_crm_automation_scoring_rule_by_id

Get a single Zoho CRM scoring rule by id. Returns: id, name, description, module, layout, field_rules, touch_point_rules, custom_fields. Required: id.

create_a_zoho_crm_automation_scoring_rule

Configure one or more scoring rules for a module and layout in Zoho CRM. Up to 250 rules can be submitted per request. Returns: id, name, description, module, layout, field_rules, touch_point_rules, custom_fields. Required: scoring_rules.

update_a_zoho_crm_automation_scoring_rule_by_id

Update an existing Zoho CRM scoring rule by id. Supports modifying name, description, field_rules, touch_point_rules, and custom_fields. Returns: id, name, description, module, layout, field_rules, touch_point_rules, custom_fields. Required: id, scoring_rules.

delete_a_zoho_crm_automation_scoring_rule_by_id

Delete a single Zoho CRM scoring rule by id. Returns: id, name, description, module, and layout on successful deletion. Required: id.

zoho_crm_automation_scoring_rules_bulk_update

Update multiple scoring rules in zohocrm in a single bulk request. Returns the updated rule objects including id, status, and layout. Required: scoring_rules.

zoho_crm_automation_scoring_rules_bulk_delete

Delete one or more scoring rules in zohocrm by rule_id. Returns the affected rule objects including id, status, and layout. Required: rule_id.

zoho_crm_automation_scoring_rules_activate

Activate a scoring rule in zohocrm by rule_id. Returns the activated rule object including id, status, and layout. Required: rule_id.

zoho_crm_automation_scoring_rules_clone

Clone a scoring rule in zohocrm by rule_id. Returns the newly cloned rule object including id, status, and layout. Required: rule_id.

zoho_crm_automation_scoring_rules_automation_bulk_delete

Delete one or more scoring rules in Zoho CRM. Returns per-rule deletion status including code, status, message, and details for each rule processed.

list_all_zoho_crm_photos

Download the photo associated with a zohocrm record. Returns raw binary PNG image data (image/png) when a photo exists for the record, or no content if none is found. Required: module, record.

create_a_zoho_crm_photo

Upload a photo for a zohocrm record using multipart form data. Returns: code, message, status, details indicating the outcome of the upload. Required: module, record, file.

zoho_crm_photos_bulk_delete

Delete the photo from a zohocrm record. Returns an empty 204 response on success. Required: module, record.

zoho_crm_records_count

Get the total number of records in a Zoho CRM module, with optional filtering by a Custom View or search parameters. Returns: count. Required: module_api_name. Supply either cvid or one of criteria, email, phone, or word — combining cvid with any search parameter results in an AMBIGUITY_DURING_PROCESSING error.

list_all_zoho_crm_services_s

List all services records in Zoho CRM. Returns: id, attributes (module-specific field values whose shape depends on the Services module configuration).

get_single_zoho_crm_services_by_id

Get a single services record by id from Zoho CRM. Returns: id, attributes (module-specific field values). Required: id.

create_a_zoho_crm_services

Create one or more services records in Zoho CRM. Returns: code, details, message, status for each submitted record. Required: data.

update_a_zoho_crm_services_by_id

Update an existing services record by id in Zoho CRM. Returns: code, details, message, status. Required: id, data.

delete_a_zoho_crm_services_by_id

Delete a services record by id from Zoho CRM. Returns: code, details, message, status. Required: id.

zoho_crm_services_s_bulk_update

Update multiple Zoho CRM Services records in a single request. Returns an array of per-record operation results, each containing code, details, message, and status. Required: data (array of service objects each including id and the fields to update).

zoho_crm_services_s_bulk_delete

Delete multiple Zoho CRM Services records by their IDs in a single request. Returns an array of per-record operation results, each containing code, details, message, and status. Required: ids.

list_all_zoho_crm_settings_profiles

List zohocrm CRM profiles with their metadata. Returns: id, name, api_name, display_label, type, custom, created_time, modified_time, description, permissions_details, sections. Max 200 profiles per response.

get_single_zoho_crm_settings_profile_by_id

Get a single zohocrm CRM profile by id. Returns: id, name, api_name, display_label, type, custom, created_time, modified_time, description, permissions_details, sections. Required: id.

update_a_zoho_crm_settings_profile_by_id

Update a zohocrm CRM profile by id, modifying its name, description, and individual permission toggles. Returns: id, status, code, message, details. Required: id, profiles.

delete_a_zoho_crm_settings_profile_by_id

Delete a zohocrm CRM profile by id, transferring its users to another profile. Returns: status, code, message, details. Required: id, transfer_to_id.

zoho_crm_settings_profiles_clone

Clone a zohocrm CRM profile by id to create a new profile. Returns: id, name, api_name, display_label, type, custom, created_time, modified_time, description, permissions_details, sections. Required: id, profiles.

list_all_zoho_crm_settings_record_locking_configurations

List record locking configurations in Zoho CRM for a module. Returns: id, lock_type, locked_for, restricted_actions, locking_rules, excluded_fields, lock_excluded_profiles, lock_for_portal_users, system_defined, created_time, modified_time, created_by, and modified_by. Required: module.

get_single_zoho_crm_settings_record_locking_configuration_by_id

Get a single record locking configuration by id in Zoho CRM. Returns: id, lock_type, locked_for, restricted_actions, locking_rules, excluded_fields, lock_excluded_profiles, lock_for_portal_users, system_defined, created_time, modified_time, created_by, and modified_by. Required: id, module.

create_a_zoho_crm_settings_record_locking_configuration

Create a record locking configuration in Zoho CRM for a module. Returns: id, lock_type, locked_for, restricted_actions, locking_rules, excluded_fields, lock_excluded_profiles, lock_for_portal_users, system_defined, feature_type, created_time, and created_by. Required: module.

update_a_zoho_crm_settings_record_locking_configuration_by_id

Update a record locking configuration by id in Zoho CRM. Returns: id, lock_type, locked_for, restricted_actions, locking_rules, excluded_fields, lock_excluded_profiles, lock_for_portal_users, system_defined, feature_type, modified_time, and modified_by. Required: id.

delete_a_zoho_crm_settings_record_locking_configuration_by_id

Delete a record locking configuration by id in Zoho CRM. Returns an empty 204 response on success. Required: id.

zoho_crm_settings_record_locking_configurations_bulk_update

Update record locking configurations for different modules in Zoho CRM. Returns: status, code, message, details (with updated configuration id). Required: module, record_locking_configurations (array, each item requires id). Array accepts at most 1 item per request.

zoho_crm_settings_record_locking_configurations_bulk_delete

Delete record locking configurations by IDs for a module in Zoho CRM. Returns: status, code, message, details (with deleted configuration id). Required: module, ids.

list_all_zoho_crm_settings_recycle_bins

List recycle bin records in zohocrm. Returns a paginated collection of deleted records, each including id, display_name, deleted_time, module, owner, and deleted_by.

get_single_zoho_crm_settings_recycle_bin_by_id

Get a single zohocrm recycle bin record by id. Returns: id, display_name, deleted_time, owner, module (with api_name and id), and deleted_by. Required: id.

create_a_zoho_crm_settings_recycle_bin

Restore a recycle bin record. Restores a single recycle-bin record identified by the path parameter `record_id`.

delete_a_zoho_crm_settings_recycle_bin_by_id

Permanently delete a single zohocrm recycle bin record by id. This action is irreversible. Returns: status, code, message, and details (including the id of the deleted record). Required: id.

zoho_crm_settings_recycle_bins_bulk_delete

Permanently delete multiple zohocrm recycle bin records in a single request. Returns per-record results including status, code, message, and details.

zoho_crm_settings_recycle_bins_count

Get the total count of records currently in the zohocrm recycle bin. Returns: count.

zoho_crm_settings_recycle_bins_empty

Empty the recycle bin. Permanently deletes all records from the Recycle Bin. This action is irreversible, as deleted records cannot be restored after this operation. When the number of records in the Recycle Bin exceeds 1000 (including child records), the deletion will be scheduled as a background job (202 status). If the count is 1000 or fewer, the records are deleted immediately (200 status). Only users with the Admin profile can empty the Recycle Bin.

zoho_crm_settings_recycle_bins_restore

Restore records from the zohocrm recycle bin by providing ids, filters, or restore_all_records — exactly one must be supplied; they are mutually exclusive. Returns per-item results with id, status, code, message, and details. When more than 1,000 records (including child records) need to be restored, the operation is scheduled as a background job (202 response).

list_all_zoho_crm_settings_related_lists

List related lists configuration in Zoho CRM for a specific module. Returns: id, display_label, name, module, type, visible, sequence_number, actions, href. Required: module.

list_all_zoho_crm_settings_roles

List all CRM roles in the Zoho CRM organization. Returns: id, name, api_name, display_label, share_with_peers, reporting_to, forecast_manager, description, created_by__s, modified_by__s, created_time__s, modified_time__s. Max 250 roles per response.

get_single_zoho_crm_settings_role_by_id

Get a single Zoho CRM role by id. Returns: id, name, api_name, display_label, share_with_peers, reporting_to, forecast_manager, description, created_by__s, modified_by__s, created_time__s, modified_time__s. Required: role.

create_a_zoho_crm_settings_role

Create one or more new CRM roles in the Zoho CRM organization (up to 100 per request). Returns: code, details (containing the new role id), message, status for each created role. Required: roles.

update_a_zoho_crm_settings_role_by_id

Update a single Zoho CRM role by id. Returns: code, details (containing the updated role id), message, status confirming the update. Required: role.

delete_a_zoho_crm_settings_role_by_id

Delete a single Zoho CRM role by id. Returns: code, details, message, status confirming the deletion. Required: role.

zoho_crm_settings_roles_bulk_update

Update multiple Zoho CRM roles in a single request. Returns: id, name, description, reporting_to, and share_with_peers for each updated role. Required: roles (array of role objects, each containing id and the fields to update).

zoho_crm_settings_roles_bulk_delete

Delete multiple Zoho CRM roles in a single request. Returns: id, name, description, reporting_to, and share_with_peers for each affected role. Required: roles (array of role objects, each containing id).

list_all_zoho_crm_settings_service_preferences

Retrieve service preference settings for the zohocrm organization. Returns: job_sheet_enabled (boolean indicating whether job sheet generation is enabled upon appointment completion).

zoho_crm_settings_service_preferences_bulk_update

Update service preference settings for the zohocrm organization. Returns: job_sheet_enabled. Required: service_preferences.

list_all_zoho_crm_timelines

List timeline entries for a zohocrm record, showing its full activity history. Returns an array of timeline event objects each containing id, audited_time, action, source, done_by, related_record, extension, automation_details, and record. Required: module, record_id.

list_all_zoho_crm_business_hours_shift_hours

List all configured shift hours in Zoho CRM, including timing, break hours, users, and holidays for each shift. Returns: id, name, timezone, shift_days, same_as_everyday, users_count, break_hours, holidays, users.

get_single_zoho_crm_business_hours_shift_hour_by_id

Get a single Zoho CRM shift hour configuration by its identifier. Returns: id, name, timezone, shift_days, same_as_everyday, users_count, break_hours, holidays, users. Required: shift.

create_a_zoho_crm_business_hours_shift_hour

Create one or more new shift hour configurations in Zoho CRM with timing, timezone, break hours, and shift day settings. Returns: id, name, timezone, shift_days, same_as_everyday, users_count, break_hours, holidays, users. Required: shift_hours.

update_a_zoho_crm_business_hours_shift_hour_by_id

Update an existing Zoho CRM shift hour configuration by its identifier. Returns: id, name, timezone, shift_days, same_as_everyday, users_count, break_hours, holidays, users. Required: shift.

delete_a_zoho_crm_business_hours_shift_hour_by_id

Delete a Zoho CRM shift hour configuration by its identifier. Returns an empty 204 response on success. Required: shift.

zoho_crm_business_hours_shift_hours_bulk_update

Update multiple shift hours records in bulk in Zoho CRM. Returns: code, status, message, and details for each operation result. Required: shift_hours.

zoho_crm_business_hours_shift_hours_bulk_delete

Delete multiple shift hours records in bulk in Zoho CRM. Returns: code, status, message, and details for each deletion result. Required: shift_hours.

list_all_zoho_crm_settings_territories

List all Zoho CRM territories. Returns: id, name, description, permission_type, manager, reporting_to per territory record. Use the include parameter to add account_rule_criteria, lead_rule_criteria, or deal_rule_criteria to each result.

get_single_zoho_crm_settings_territory_by_id

Get a single Zoho CRM territory by id. Returns the territory object including id, name, description, permission_type, manager, and reporting_to. Required: id.

create_a_zoho_crm_settings_territory

Transfer records from a specific Zoho CRM territory and delete it. Returns operation results including code, status, message, and details per territory. Required: id.

update_a_zoho_crm_settings_territory_by_id

Update a Zoho CRM territory by id. Returns operation results including code, status, message, and details. Required: id.

delete_a_zoho_crm_settings_territory_by_id

Delete a Zoho CRM territory by id. Returns operation results including code, status, message, and details. Required: id.

zoho_crm_settings_territories_bulk_update

Bulk update up to 100 territories in zohocrm in a single request. Returns: code, details, message, status per territory operation result. Required: territories (array; each item must include id).

zoho_crm_settings_territories_bulk_delete

Delete multiple territories in zohocrm by their IDs in a single request. Returns: code, details, message, status per territory operation result. Required: ids.

zoho_crm_settings_territories_associated_users_count

Get the number of users associated with each territory in zohocrm. Returns: count and territory (containing id and name) for each entry.

zoho_crm_settings_territories_transfer_and_delete

Transfer records from multiple territories to another territory and then delete them in zohocrm. Returns: code, details, message, status per territory operation result. Required: territories (array; each item must include id).

create_a_zoho_crm_settings_territories_setting

Create Territories. Auto-generated description for operation `Create Territories`.

list_all_zoho_crm_settings_unsubscribe_links

List all unsubscribe links configured in zohocrm. Returns: id, name, submission_action_type.

get_single_zoho_crm_settings_unsubscribe_link_by_id

Get a single zohocrm unsubscribe link by id. Returns: id, name, submission_action_type. Required: id.

create_a_zoho_crm_settings_unsubscribe_link

Create a new unsubscribe link in zohocrm. Returns: id, name, submission_action_type. Required: submission_action_type.

update_a_zoho_crm_settings_unsubscribe_link_by_id

Update an existing zohocrm unsubscribe link by id. Returns: id, name, submission_action_type. Required: id.

delete_a_zoho_crm_settings_unsubscribe_link_by_id

Delete a zohocrm unsubscribe link by id. Returns: code, status, message, details. Required: id.

zoho_crm_settings_unsubscribe_links_bulk_update

Bulk update multiple unsubscribe links in Zoho CRM via a single PUT request. Returns modification results for each record including code, status, message, and details. Required: unsubscribe_links in the request body.

zoho_crm_settings_unsubscribe_links_associations

Get association information for unsubscribe links configured in Zoho CRM, showing where each link is used. Returns id, name, and associated_places for each link. Returns a 204 response when no associations exist.

list_all_zoho_crm_settings_user_groups

List all user groups available in the Zoho CRM organization. Returns: id, name, description, created_by, modified_by, created_time, modified_time, and sources_count per group.

get_single_zoho_crm_settings_user_group_by_id

Get a single Zoho CRM user group by ID. Returns: id, name, description, created_by, modified_by, created_time, modified_time, and sources_count. Required: group.

create_a_zoho_crm_settings_user_group

Create a new user group in Zoho CRM. Returns: code, status, message, and details (containing the id of the newly created group). Required: user_groups (array with each entry requiring name and sources).

update_a_zoho_crm_settings_user_group_by_id

Update Group. Update an existing user group in your organization.

delete_a_zoho_crm_settings_user_group_by_id

Delete a Zoho CRM user group by ID. Returns an empty 204 response on success. Required: group.

zoho_crm_settings_user_groups_associated_users_count

Get the count of users associated with each user group in Zoho CRM, with optional filtering. Returns: user_group (with id and name) and count of associated users per group.

zoho_crm_settings_user_groups_associations

Get the associations for a specific Zoho CRM user group, finding where it is used across sharing rules, workflows, assignment rules, approval processes, and email notifications. Returns: resource (id, name), details (module api_name, id), and type. Required: group.

zoho_crm_settings_user_groups_sources_count

Get the count of sources (territories, roles, groups, and users by status) for a specified Zoho CRM user group. Returns: territories, roles, groups, and users (with active, inactive, and deleted counts). Required: group.

zoho_crm_settings_user_groups_bulk_update

Bulk update multiple Zoho CRM user groups in a single request. Returns: code, status, message, and details for each updated group. Required: user_groups.

zoho_crm_settings_user_groups_bulk_delete

Bulk delete multiple Zoho CRM user groups in a single request. Returns: code, status, message, and details for each deleted group. Required: user_groups.

get_single_zoho_crm_settings_variable_group_by_id

Get a specific variable group from Zoho CRM settings by id. Returns: id, name, api_name, description, and variables. Required: id.

update_a_zoho_crm_settings_variable_group_by_id

Update a variable group's details in Zoho CRM settings by id. Returns the operation result including code, details, message, and status. Required: id.

list_all_zoho_crm_settings_variable_groups

List all variable groups created in the Zoho CRM org. Returns variable group records including id, name, api_name, description, and variables.

zoho_crm_settings_variable_groups_bulk_update

Bulk update multiple variable groups in Zoho CRM settings in a single request. Returns operation results for each updated group including code, details, message, and status. Required: variable_groups.

list_all_zoho_crm_territorie_child_territories

List child territories under a parent territory in zohocrm. Returns: id, name, api_name, permission_type, manager, reporting_to, created_time, modified_time, created_by, modified_by, description, account_rule_criteria, deal_rule_criteria, and lead_rule_criteria. Required: id.

list_all_zoho_crm_territorie_users

List users associated with a Zoho CRM territory. Returns: id. Required: territory.

get_single_zoho_crm_territorie_user_by_id

Get a single user associated with a Zoho CRM territory by user ID. Returns: id. Required: territory, user.

update_a_zoho_crm_territorie_user_by_id

Add a user to a Zoho CRM territory. Returns the operation result including code, status, message, and details with the user id. Required: territory, user, users.

delete_a_zoho_crm_territorie_user_by_id

Remove a user from a Zoho CRM territory. Returns the operation result including code, status, message, and details with the user id. Required: territory, user.

zoho_crm_territorie_users_bulk_update

Add up to 100 users to a Zoho CRM territory in a single request. Returns the operation result per user including code, status, message, and details with id. Required: territory, users.

zoho_crm_territorie_users_bulk_delete

Bulk disassociate users from a Zoho CRM territory. Returns an array of operation status results per user, including code, message, status, and details. Required: territory.

create_a_zoho_crm_upload

Upload a file to zohocrm using multipart/form-data. Returns: status, code, message, and details containing the file_id and created_time of the uploaded file. Required: file.

list_all_zoho_crm_user_group_sources

List sources for a specified zohocrm user group. Returns: source (containing id and name), type, subordinates, and sub_territories for each source entry. Required: group.

list_all_zoho_crm_user_territories

List territories assigned to a specific user in Zoho CRM. Returns: id for each territory record in the collection. Required: user.

get_single_zoho_crm_user_territory_by_id

Get a specific territory assigned to a user in Zoho CRM. Returns: id for the territory record. Required: user, territory.

update_a_zoho_crm_user_territory_by_id

Associate a territory to a user in Zoho CRM. Returns: code, status, message for the operation result. Required: user, territory, territories.

delete_a_zoho_crm_user_territory_by_id

Remove a specific territory from a user in Zoho CRM. Returns: code, status, message indicating the removal result. Required: user, territory.

zoho_crm_user_territories_bulk_update

Associate or update multiple territories for a user in Zoho CRM in a single request. Returns: code, status, message for each operation result. Required: user, territories.

zoho_crm_user_territories_bulk_delete

Remove multiple territories from a user in Zoho CRM. Returns: code, status, message, details for each territory removal operation. Required: user.

list_all_zoho_crm_zia_org_enrichments

List Zoho CRM Zia organization enrichment jobs with optional status filtering and sorting. Returns: id, status, created_time, created_by.

get_single_zoho_crm_zia_org_enrichment_by_id

Get a single Zoho CRM Zia organization enrichment record by id. Returns: id, status, enrich_based_on (name, email, website), enriched_data. Required: id.

create_a_zoho_crm_zia_org_enrichment

Trigger a Zia organization enrichment job in zohocrm for a specific CRM record. Returns: code, details (with id of the scheduled job), message, status. Required: module, __zia_org_enrichment. Max 50 enrichment inputs per request.

list_all_zoho_crm_automation_tasks

List automation tasks configured in the Zoho CRM organization. Returns task records including id, module, and feature_type. Optionally filter by feature_type or module.

get_single_zoho_crm_automation_task_by_id

Get a single Zoho CRM automation task by id. Returns the task object including id, module, and feature_type. Required: id.

create_a_zoho_crm_automation_task

Create a new automation task in the Zoho CRM organization. Returns the created task record including id, module, and feature_type.

update_a_zoho_crm_automation_task_by_id

Update an existing automation task in Zoho CRM by id. Returns the updated task record including id, module, and feature_type. Required: id.

delete_a_zoho_crm_automation_task_by_id

Delete an automation task from Zoho CRM by id. Returns a 200 response with code, details, message, and status confirming deletion. Required: id.

zoho_crm_automation_tasks_bulk_delete

Delete multiple automation tasks configured in Zoho CRM in a single request. Returns per-task results including code, status, message, and details for each submitted ID. A 207 response is returned when some tasks are deleted successfully and others fail. Required: ids.

list_all_zoho_crm_automation_webhook_failures

List webhook execution failures in zohocrm to retrieve detailed information about failed webhook executions in your organization. Returns: id, webhook_id, module, created_time. Supports optional filtering by webhook_id, module, and date range via from and to parameters.

list_all_zoho_crm_automation_webhooks

List all webhooks configured in your Zoho CRM account. Returns: id, name, url, method. Optional filters include module, sort_by, sort_order, feature_type, related_module, and filters.

get_single_zoho_crm_automation_webhook_by_id

Get a single webhook by id from your Zoho CRM account. Returns: id, name, url, method. Required: id.

create_a_zoho_crm_automation_webhook

Create one or more webhooks in Zoho CRM to send real-time notifications to external services when records are created, updated, or deleted. Returns: id, name, url, method.

update_a_zoho_crm_automation_webhook_by_id

Update an existing webhook by id in your Zoho CRM account. Returns: id, name, url, method. Required: id.

zoho_crm_automation_webhooks_bulk_update

Update multiple existing webhooks in your Zoho CRM account in a single request. Returns: id, name, url, method. Each webhook in the request body must include its id.

delete_a_zoho_crm_automation_webhook_by_id

Delete a single webhook by id in Zoho CRM. Returns: code, status, message, details. Required: id.

zoho_crm_automation_webhooks_bulk_delete

Delete one or more webhooks in Zoho CRM in a single call. Returns: code, status, message, details per webhook. Required: ids. Max 10 webhooks per call.

zoho_crm_automation_webhooks_associated_modules

List all modules associated with webhook actions in the current Zoho CRM account. Returns: api_name, module_name.

zoho_crm_automation_webhooks_usage_reports

Retrieve usage statistics for webhook actions executed in Zoho CRM over the last seven days. Returns: webhook, status, executed_time. Optional filters: group_by, type, from, to.

list_all_zoho_crm_automation_workflow_rules

List all workflow rules in Zoho CRM. Returns: id, module, status, execute_on.

get_single_zoho_crm_automation_workflow_rule_by_id

Get the details of a specific workflow rule in Zoho CRM by id. Returns: id, module, status, execute_on. Required: id.

create_a_zoho_crm_automation_workflow_rule

Configure a new workflow rule in Zoho CRM. Returns: id, module, status, execute_on of the created rule. Required: workflow_rules.

update_a_zoho_crm_automation_workflow_rule_by_id

Update an existing workflow rule by id in Zoho CRM with partial data. Returns: id, module, status, execute_on. Required: id, workflow_rules.

zoho_crm_automation_workflow_rules_bulk_update

Update multiple existing workflow rules in Zoho CRM, with rule IDs specified in the request body. Returns: id, module, status, execute_on. Required: workflow_rules.

delete_a_zoho_crm_automation_workflow_rule_by_id

Delete a zohocrm workflow rule by id. Returns: code, status, message, details confirming the deletion. Required: id.

zoho_crm_automation_workflow_rules_bulk_delete

Delete multiple zohocrm workflow rules at once. Returns: code, status, message per processed rule. Required: ids.

zoho_crm_automation_workflow_rules_actions_count

Get the total count of actions configured in specified zohocrm workflow rules, categorized by action type including instant and scheduled actions. Returns: id, instant_actions, scheduled_actions. Required: ids.

zoho_crm_automation_workflow_rules_rules_count

Fetch the limit and usage details of zohocrm workflow rules and actions in the account, tracking how many are configured and how many more can be created. Returns: rules, actions with their respective usage and limit breakdowns.

zoho_crm_automation_workflow_rules_module_specific_count

Get zohocrm workflow rule action counts for a specific CRM module. Returns: module, count. Required: module.

zoho_crm_automation_workflow_rules_reorder

Update the execution order of Zoho CRM workflow rules for a specific module. By default rules execute in creation order; this endpoint lets you reassign that sequence. Returns: id, execution_order. Required: module.

zoho_crm_automation_workflow_rules_usage

Retrieve the usage report of a specific Zoho CRM workflow rule, showing how many times it was triggered and the success or failure metrics for each associated action within an optional date range. Returns: triggered_count, actions. Required: workflow_rule_id.

list_all_zoho_crm_settings_variables

List all settings variables in Zoho CRM. Returns: id, name, type, value, variable_group, api_name.

get_single_zoho_crm_settings_variable_by_id

Get a single Zoho CRM settings variable by id. Returns: id, name, type, value, description, variable_group, api_name. Required: id.

create_a_zoho_crm_settings_variable

Create one or more Zoho CRM settings variables in a batch. Returns: code, status, message, details (including the id of each created variable) per item. Required: variables.

update_a_zoho_crm_settings_variable_by_id

Update a single Zoho CRM settings variable by id. Returns: code, status, message, details for the updated variable. Required: id, variables.

zoho_crm_settings_variables_bulk_update

Update multiple Zoho CRM settings variables in a single batch request. Returns: code, status, message, details per updated variable. Required: variables.

delete_a_zoho_crm_settings_variable_by_id

Delete a specific zohocrm settings variable by id. Returns the deletion result including code, details, message, and status. Required: id.

zoho_crm_settings_variables_bulk_delete

Delete multiple zohocrm settings variables in bulk. Returns per-variable results including code, details, message, and status via a 207 Multi-Status response. At least one of ids or rids must be provided.

list_all_zoho_crm_settings_wizards

List all wizards configured in a zohocrm account with their basic details. Returns: id, name, display_label, active, module, created_time, modified_time, created_by, modified_by, profiles, portal_user_types, and containers. Optionally filter results by providing a module API name.

list_all_zoho_crm_workflow_configurations

List workflow configuration metadata for a zohocrm module. Returns the available triggers for the module, the actions supported for each trigger, and their limits and properties. Required: module.

list_all_zoho_crm_zia_data_enrichments

List Zia data enrichment configurations in zohocrm. Returns each configuration's id, type, module, status, input_data_field_mapping, created_time, created_by, modified_time, and modified_by.

list_all_zoho_crm_settings_modules_settings

List all module settings metadata in zohocrm, returning metadata for every configured CRM module in the organization. Returns: id.

zoho_crm_settings_modules_settings_bulk_update

Bulk update module settings metadata in zohocrm for one or more CRM modules. Returns the updated module records including id. Required: modules.

list_all_zoho_crm_contacts_roles_contacts

Get contact role details for a specific contact associated with a deal in Zoho CRM. Returns: id, Contact_Role. Required: module, deal_id, contact_id.

zoho_crm_contacts_roles_contacts_bulk_update

Associate Contact Role To Deal. Assign or update a contact role for a specific contact on a deal.

zoho_crm_contacts_roles_contacts_bulk_delete

Remove the contact role for a specific contact from a deal in Zoho CRM. Returns an empty 204 response on success. Required: module, deal_id, contact_id.

list_all_zoho_crm_settings_roles_settings

List all roles configured in the Zoho CRM organization. Returns: id, name, display_label, description, share_with_peers, reporting_to, and forecast_manager for each role.

zoho_crm_settings_roles_settings_bulk_update

Bulk update multiple roles in the Zoho CRM organization in a single request. Returns: id, name, display_label, description, share_with_peers, reporting_to, and forecast_manager for each updated role. Required: roles.

list_all_zoho_crm_territorie_users_territories

List users associated with a specific territory in Zoho CRM. Returns user records including id and name for the given territory. Required: territory, user.

zoho_crm_territorie_users_territories_bulk_update

Add users. Add users to a territory.

zoho_crm_territorie_users_territories_bulk_delete

Disassociate users from a Zoho CRM territory. Returns the affected user records including id and name. Required: territory, user.

list_all_zoho_crm_user_territories_users

List territories related to a specific user in Zoho CRM. Returns: id, name. Required: user, territory.

zoho_crm_user_territories_users_bulk_delete

Remove specific territories from a user in Zoho CRM. Returns an empty 204 response on success. Required: user, territory.

list_all_zoho_crm_settings_user_groups_settings

List user groups in zohocrm and retrieve the details of all groups configured for your organization. User groups are sets of users, roles, territories, and subordinates used to manage shared records. Returns: id, name.

list_all_zoho_crm_settings_portals_settings

List portals configured in Zoho CRM settings. Returns: id, name, url.

list_all_zoho_crm_business_hours_shift_hours_business_hours

Get details of shift hours configured for your organization in Zoho CRM. Shift hours let you assign shifts based on employees' work hours or time zone and manage activities based on user availability. Returns: id.

zoho_crm_business_hours_shift_hours_business_hours_bulk_update

Update shift hours for your organization in Zoho CRM. Accepts an array of shift hour objects to update in bulk. Returns: id. Required: shift_hours.

list_all_zoho_crm_email_drafts_email_drafts

List email drafts associated with a specific record in zohocrm. Returns email draft objects including id for the given module and record. Required: module, record.

list_all_zoho_crm_features_features

List zohocrm features and their usage limits for the current org. Returns: feature_name, limits. Limit values vary depending on the org's edition.