Zoho CRM API Directory
The API Directory provides a comprehensive list of all Zoho CRM APIs, along with links to their corresponding documentation. Please use the search bar to filter the list by API name, module, functionality or API end points.
| API Name | Description | Supported Versions | Endpoints |
|---|---|---|---|
| Create Custom Fields | To create custom fields in a module. | v6 | /settings/fields?module={module_api_name} |
| Update Custom Fields | To update custom fields in your Zoho CRM. | v6 | /settings/fields?module={module_api_name} /settings/fields/{field_id}?module={module_api_name} |
| Delete Custom Fields | To delete a custom field from a module in your Zoho CRM account. | v6 | /settings/fields/{field_id}?module={module_api_name} |
| Create Unsubscribe Link | To create an unsubscribe link, which can be used in your email templates or email footers. | v6 | /settings/unsubscribe_links |
| Get Unsubscribe Links | To fetch the details of unsubscribe links set up in your CRM account. | v6 | /settings/unsubscribe_links /settings/unsubscribe_links/{link_id} |
| Update Unsubscribe Link | To update an unsubscribe link. | v6 | /settings/unsubscribe_links/{unsubscribe_link_id} |
| Delete Unsubscribe Link | To delete an unsubscribe link. | v6 | /settings/unsubscribe_links/{unsubscribe_link_id} |
| Get Unsubscribe Link Associations | To obtain information regarding the associations of unsubscribe links configured in your account. | v6 | /settings/unsubscribe_link/actions/associations |
| Merge Records | To merge up to three duplicate records into a single record and delete the duplicates. | v6 | /{module_api_name}/{master-record_id}/actions/merge |
| Get Records Merge Status | To get the status of previously scheduled records merge job. | v6 | /{module_api_name}/{master_record_id}/actions/merge |
| Get Related Records of a Deleted Record | To get the related list records of a deleted record. | v6 | /{module_api_name}/deleted/{deleted_record_id}/{related_list_api_name} |
| Features | To retrieve details of features and its limits for your current org. | v6 | /__features /__features?module={module_api_name} /__features?api_names={feature_api_name_1},{feature_api_name_2} /__features/{feature_api_name} |
| Create Global Picklist | To create a global set or a global picklist. | v6 | /settings/global_picklists |
| Get Global Picklists | To retrieve the details of global picklists configured in your Zoho CRM account. | v6 | /settings/global_picklists /settings/global_picklists/{global_picklist_id} |
| Update Global Picklist | To update a global picklist or a global set. | v6 | /settings/global_picklists/{global_picklist_id} |
| Delete Global Picklist | To delete a global picklist configured in your Zoho CRM account. | v6 | /settings/global_picklists/{global_picklist_id} |
| Get Global Picklist option replace job status | To get the status of a scheduled picklist option replacement job initiated through the replace picklist value API. | v6 | /settings/global_picklists/{global_picklist_id}/actions/replaced_values |
| Replace Global PickList Value | To replace a picklist value from all the used places, with another existing option of the global picklist. | v6 | /settings/global_picklists/{global_pick_list_id}/actions/replace_picklist_values |
| Get Global Picklists Features Association | Get details of the features where a specific option of a global picklist is associated, like workflows or blueprints. | v6 | /settings/global_picklists/{global_picklist_id}/actions/pick_list_values_associations |
| Get Global Picklist Field Associations | To retrieve information on the fields, modules, and layouts where a global picklist is associated | v6 | /settings/global_picklists/{global_picklist_id}/actions/associations |
| Unblock Email Address | To unblock the soft bounced emails. | v6 | /{module_api_name}/{record_id}/actions/unblock_email /{module_api_name}/actions/unblock_email |
| Get User Licences Count | To retrieve the count of purchased, active and available user licences in your organization. | v6 | /__features/user_licenses |
| GET Record Locking Configuration | To retrieve the record locking configuration for different modules. | v6, v5, v4, v3 | /settings/record_locking_configurations?module={module_API_name} |
| Add Record Locking Configuration | To add record locking configuration for different modules. | v6, v5, v4, v3 | /settings/record_locking_configurations?module={module_API_name} |
| Update Record Locking Configuration | To update the record locking configuration for different modules. | v6, v5, v4, v3 | /settings/record_locking_configurations?module={module_API_name} /settings/record_locking_configurations/{record_locking_config_id}?module={module_API_name} |
| Delete Record Locking Configuration | To delete the record locking configuration for different modules. | v6, v5, v4, v3 | /settings/record_locking_configurations/{record_locking_config_id}?module={module_API_name} |
| GET Record Locking Information | To retrieve the locking information details of locked records. | v6, v5, v4, v3 | /{module_API_name}/{record_id}/Locking_Information__s /{module_API_name}/{record_id}/Locking_Information__s/{record_locking_id} |
| Lock Records | To lock a record of a module. | v6, v5, v4, v3 | /{module_API_name}/{record_id}/Locking_Information__s |
| Update Record Locking Information | To modify locking information of locked records in different modules. | v6, v5, v4, v3 | /{module_API_name}/{record_id}/Locking_Information__s/{record_locking_id} |
| Unlock Records | To remove lock from locked records. | v6, v5, v4, v3 | /{module_API_name}/{record_id}/Locking_Information__s/{record_locking_id} |
| Add Appointments Rescheduled History | To add new records in the appointments rescheduled history. | v6, v5, v4, v3, v2.1, v2 | /Appointments_Rescheduled_History__s |
| Add Business Hours | To set the business hours for your organization. | v6, v5, v4 | /settings/business_hours |
| Add Contact Roles to a Specific Deal | To add contact roles to a specific deal. | v6, v5, v4, v3, v2.1, v2 | /Deals/{deal_ID}/Contact_Roles/{contact_id} |
| Add Currencies | To add new currencies to your organization. | v6, v5, v4, v3, v2.1, v2 | /org/currencies |
| Add Holiday | Every business has its own holidays including the national holidays and the ones specific to the business or the region. Use this API to add holidays to your org. | v6, v5, v4 | /settings/holidays |
| Add Shift Hours | To set shift hours for your organization through an API. | v6, v5, v4 | /settings/business_hours/shift_hours |
| Add Tags | To add tags to records. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/actions/add_tags /{module_api_name}/{record_id}/actions/add_tags |
| Add Territories | To add new territories to your organization. | v6, v5 | /settings/territories |
| Add or Update Territories of a User | To add or update the territories related to a user. | v6, v5, v4, v3 | /users/{id}/territories |
| Add User | To add a user to your organization. | v6, v5, v4, v3, v2.1, v2 | /users |
| Assign Territories to Records | To assign territories to multiple records or a single record. | v6, v5, v4, v3, v2.1 | /{module_api_name}/actions/assign_territories /{module_api_name}/{record_id}/actions/assign_territories |
| Associate Email with a Record | To associate an email with a record entity. | v6, v5 | /{module}/{entity_id}/actions/associate_email |
| Associate Users with Territory | To associate users with a territory in your organization. | v6, v5 | /settings/territories/{territoryid}/users /settings/territories/{territoryid}/users/{userid} |
| Get Associated Groups of a User | To get the groups that a user is associated with. | v6, v5 | /users/{user_ID}/actions/associated_groups |
| Get Associated Users' Count | To get the number of users associated with each user group. | v6, v5 | /settings/user_groups/actions/associated_users_count |
| Associated User Count of Territories | To retrieve the count of users under the territories in your organization. | v6, v5 | /territories/actions/associated_users_count |
| Get Data Backup History | To fetch information about the recent data backups scheduled for your CRM account in the last one year. | v6, v5, v4, v3 | /bulk/{version}/backup/history |
| Get Blueprint Data | To get the next available transitions for a record, fields available for each transitions, current value of each field, and their validation(if any). | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/actions/blueprint |
| Create Bulk Read job (Bulk Export) | To create a bulk read job to export records. | v6, v5, v4, v3, v2.1, v2 | /bulk/{version}/read |
| Download Bulk Read Result | To download the bulk read job in zip format. | v6, v5, v4, v3, v2.1, v2 | /bulk/{version}/read/{job_id}/result |
| Get the Status of a Bulk Read Job | To get the details of a bulk read job scheduled previously. | v6, v5, v4, v3, v2.1, v2 | /bulk/{version}read/{job_id} |
| Create Bulk Write Job | To schedule a bulk write job to import records into CRM. | v6, v5, v4, v3, v2.1, v2 | /bulk/{version/write |
| Download Bulk Write Result | To download the result of the bulk write job as a CSV file. | v6, v5, v4, v3, v2.1, v2 | |
| Get Bulk Write Job Details | To get the details of a bulk write job scheduled previously. | v6, v5, v4, v3, v2.1, v2 | /bulk/{version}/write/{job_id} |
| Bulk Write Upload File | To upload a CSV file in ZIP format for bulk write API. | v6, v5, v4, v3, v2.1, v2 | /upload |
| Cancel Scheduled Data Backup | To cancel the scheduled data backup of your CRM account. | v6, v5, v4, v3 | /bulk/v6/backup/{id}/actions/cancel |
| Change Owner | To change the owner of a record or multiple records. | v6, v5, v4, v3 | /{module_api_name}/actions/change_owner /{module_api_name}/{record_id}/actions/change_owner |
| Change User Status (Portal) | To change the status of a user in the portal. | v6, v5 | /settings/portals/{portal_name}/user_type/{user_type_id}/users/{user_id}/actions/change_status |
| Clone Scoring Rule | To clone a scoring rule. | v6, v5, v4, v3 | /settings/automation/scoring_rules/{rule_id}/actions/clone |
| Composite API | To perform a composite API call, consisting of up to five sub-requests. | v6, v5, v4, v3 | /__composite_requests |
| Convert Lead | To convert a lead into a contact or an account. | v6, v5, v4, v3, v2.1, v2 | /Leads/{record_id}/actions/convert |
| Create Appointments | To add new appointments to your organization. | v6, v5 | /Appointments__s |
| Create Notes | To add new notes. | v6, v5, v4, v3, v2.1, v2 | /Notes /{module_api_name}/{record_id}/Notes |
| Create Pipeline | To create a pipeline with various stages that a deal passes through. | v6, v5, v4, v3, v2.1 | /settings/pipeline?layout_id={layout_id} |
| Create Portal | To create a portal for your org. | v6, v5 | /settings/portals |
| Create Profile | To create a profile. | v6 v5 | /settings/profiles/{clone-profile-id}/actions/clone |
| Create Role | To add a new role to your organization. | v6, v5, v4, v3, v2.1 | /settings/roles |
| Create Scoring Rules | To create a scoring rule for a module in the organization. | v6, v5, v4, v3 | /settings/automation/scoring_rules |
| Create Services | To add new services to your organization. | v6, v5, v4, v3 | /Services__s |
| Create Tag | To create tags and color-code them. | v6, v5, v4, v3, v2.1, v2 | /settings/tags?module={module_api_name} |
| Create User Group | To create a user group. | v6, v5 | /settings/user_groups |
| Create User Type | To create a user type in a portal. | v6, v5 | /settings/portals/{portal_name}/user_type |
| Create Variables | To create a new variable in CRM. | v6, v5, v4, v3, v2.1, v2 | /settings/variables |
| Custom View Meta | To get the custom views data of a particular module. | v6, v5, v4, v3, v2.1, v2 | /settings/custom_views?module={module_api_name} /settings/custom_views/{custom_view_id}?module={module_api_name} |
| Delete User Unavailability | To delete the record that contains the details of your unavailability. | v6, v5, v4, v3, v2.1 | /settings/users_unavailability/{id} |
| Delete Appointments Rescheduled History | To delete a record from the appointments rescheduled history. | v6, v5, v4, v3 | /Appointments_Rescheduled_History__s/{record_id} |
| Delete Appointments | To delete existing appointments in your organization. | v6, v5, v4, v3 | /Appointments__s?ids={appointment_id1,appointment_id2,...appointment_id100} /Appointments__s/{appointment_id} |
| Delete Attachments | To delete a file attached to a record. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/Attachments/{attachment_id} /{module_api_name}/{record_id}/photo |
| Delete Contact Roles | To delete contact roles. | v6, v5, v4, v3, v2.1, v2 | /Contacts/roles?ids={contact_role_id1,contact_role_id2,..} /Contacts/roles/{contact_role_id} |
| Delete Holiday | To delete the holidays set for your org. | v6, v5 | /settings/holidays/{holiday_id} |
| Delete Record Photo | To delete a photo from a record in a module. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/Attachments/{attachment_id} /{module_api_name}/{record_id}/photo |
| Delete Mapped Dependency | To delete the dependency mapped for the picklist fields on a layout of the module. | v6 v5 | /settings/layouts/{layout_id}/map_dependency/{map_dependency_id} |
| Delete Notes | To delete notes. | v6, v5, v4, v3, v2.1, v2 | /Notes/{note_id} /Notes?ids={Entity_ID1, Entity_ID2, Entity_ID3,..} /{module_api_name}/{record_id}/Notes/{note_id}} |
| Delete Organization Image | To delete the logo or photo of your organization. | v6, v5, v4, v3, v2.1, v2 | /org/photo |
| Delete Records Using External ID | To delete the records in a module using external IDs. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{external_field_value} /{module_api_name?ids=id1,id2,..} |
| Delete Records | To delete entities or records from a module. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}?ids={record_id1,record_id2,..} /{module_api_name}/{record_id} |
| Delete Related Records Using External ID | To delete the related list records using external IDs. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{external_field_value}/{related_list_api_name}/{external_field_value} |
| Delete Scoring Rules | To delete scoring rules. | v6, v5, v4, v3 | /settings/automation/scoring_rules/{rule_id} /settings/automation/scoring_rules?ids=rule_id1, rule_id2, rule_id3, ... |
| Delete Services | To delete existing services in your organization. | v6, v5 | /Services__s?ids={service_id1,service_id2,...service_id100} /Services__s/{service_id} |
| Delete Shift Hours | To delete the shift hours configured for your organization. | v6 v5 | /settings/business_hours/shift_hours/{shift_hour_id} |
| Delete Tag | To delete a tag from a module. | v6, v5, v4, v3, v2.1, v2 | /settings/tags/{tag_id} |
| Delete Territories | To delete territories from your organization. | v6, v5 | /settings/territories /settings/territories/{territory_id} |
| Delete User From Portal | To delete a user from a portal. | v6, v5, v4 | /settings/portals/{portal_name}/user_type/{user_type_id}/users |
| Delete a User Group | To delete a user group. | v6, v5, v4 | /settings/user_groups/{user_group_id} |
| Delete a User Type | To delete a user type from a portal. | v6, v5, v4 | /settings/portals/{portal_name}/user_type/{user_type_id} |
| Delete User | To delete a user from your organization. | v6, v5, v4, v3, v2.1, v2 | /users/{user_id} |
| Delete Variable | To delete details of CRM variables. | v6, v5, v4, v3, v2.1, v2 | /settings/variables?ids={variable_id1, variable_id2, variable_id3} /settings/variables/{variable_id} |
| Delink and Transfer Records | To delink a user from the territory and assign the open records to the user of another territory. | v6, v5, v4, v3 | /users/{id}/territories/actions/transfer_and_delink /users/{id}/territories/{territory_id}/actions/transfer_and_delink |
| Delink Related Records | To delete the association between modules. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id} /{module_api_name}/{record_id}/{related_list_apiname}?ids={comma_separated_related_record_ids} |
| Disassociate Users from Territory | To disassociate users from a territory in your organization. | v6, v5 | settings/territories/{territoryid}/users settings/territories/{territoryid}/users/{userid} |
| Download an Attachment | To download a file attached to a record. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/Attachments/{attachment_id} |
| Download Backed up Data | To download the backed up data for your CRM account. | v6, v5, v4, v3 | /v2/crm/{zgid}/backup/{job-id}/{file-name} |
| Download Email Attachments | To download the attachments of an email. | v6, v5, v4 | /{module_api_name}/{record_id}/Emails/actions/download_attachments |
| Download Record Image | To download a photo associated with a module. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/photo |
| Download Inline Images of an Email | To download the inline images from an email. | v6, v5, v4 | /{module_api_name}/{record_id}/Emails/actions/download_inline_images |
| Download Mail Merge | Use the download mail merge API to download the merged document created using your mail merge template. | v6, v5 | /{module_API_name}/{record_id}/actions/download_mail_merge |
| Download Field Attachments | To download the attachments from the file upload and image upload fields of a module. | v6, v5, v4, v3, v2.1 | /{module_api_name}/{record_ID}/actions/download_fields_attachment |
| Email Templates | To fetch the email templates in a module. | v6, v5, v4, v3, v2.1 | /settings/email_templates /settings/email_templates/{id} |
| Enable Multi-Currency | To enable multiple currencies for your organization. | v6, v5, v4, v3, v2.1, v2 | /org/currencies/actions/enable |
| Execute Scoring Rules | To execute scoring rules for a module in the organization. | v6, v5, v4, v3 | /{module_api_name}/actions/run_scoring_rules} |
| Field Meta | To get the field metadata for the specified module | v6, v5, v4, v3, v2.1, v2 | /settings/fields?module={module_api_name} |
| Get Appointment Preferences | To get the details of appointment preferences in your organization. | v6, v5, v4, v3 | /settings/appointment_preferences |
| Get Appointments Rescheduled History | To get appointments rescheduled history data. | v6, v5, v4, v3 | /Appointments_Rescheduled_History__s /Appointments__s/{appointment_id}/Appointments_Rescheduled_History__s |
| Get Appointments | To get appointments data that match your search criteria. | v6, v5, v4, v3 | /Appointments__s /Appointments__s/{appointment_id} |
| Get Assignment Rules | To fetch the assignment rules in your org. | v6, v5, v4, v3, v2.1 | /settings/automation/assignment_rules /settings/automation/assignment_rules/{rule_id}?module={module_API_name} |
| Get Attachments | To get the list of attachments. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/Attachments |
| Get Backup Info | To fetch information about the latest data backup scheduled for your CRM account. | v6, v5, v4, v3 | /bulk/v5/backup |
| Get Backup URLs | To fetch the download URLs of the latest scheduled backup. | v6, v5, v4, v3 | /bulk/v5/backup/urls |
| Get Business Hours | To get the details of the business hours of your org. | v6, v5, v4 v3 | /settings/business_hours |
| Get Child Territories | To retrieve the details of child territories of your territory. | v6, v5 | /settings/territories/{territoryid}/__child_territories |
| Get Contact Roles of a Specific Deal | To get the details of contact roles associated with a specific deal. | v6, v5, v4, v3, v2.1, v2 | /Deals/{deal_id}/Contact_Roles /Deals/{deal_id}/Contact_Roles/{contact_id} /Deals/{deal_id}/Contact_Roles?ids={contact_id1,contact_id2,..} |
| Get Contact Roles | To get the list of contact roles. | v6, v5, v4, v3, v2.1, v2 | /Contacts/roles /Contacts/roles/{contact_role_id} |
| Get Currencies Data | To get all the available currencies in your organization. | v6, v5, v4, v3, v2.1, v2 | /org/currencies /org/currencies/{currency_id} |
| Get Deleted Records | To get the list of deleted records. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/deleted |
| Get Emails of a Record | To get the details of the emails sent from a record. | v6, v5, v4 | /{module_api_name}/{record_id}/Emails /{module_api_name}/{record_id}/Emails/{message_id} |
| Get Email Shared Details | To get the details of the users and the type with whom you can share the record's emails. | v6, v5, v4 | /{module_api_name}/{record_id}/__emails_sharing_details |
| Get Entity Scores | To get the entity score of a record. | v6, v5, v4, v3 | /{module_api_name}/{record_id}/Entity_Scores__s |
| Get Files | To fetch a file using its encrypted ID. | v6, v5, v4, v3, v2.1, v2 | /files |
| Get Fiscal Year | To retrieve the details of fiscal year settings of your organization. | v6, v5 | /settings/fiscal_year |
| Get From Addresses List | To get the list of email addresses that you can send emails from. | v6, v5, v4, v3, v2.1 | /settings/emails/actions/from_addresses |
| Get Holidays List | To get the details of the holidays set for your org. | v6, v5, v4 | /settings/holidays /settings/holidays/{holiday_id} |
| Get Mapped Dependency Fields | To get the details of the parent and child fields configured for a module. | v6, v5, v4 | /settings/layouts/{layout_id}/map_dependency /settings/layouts/{layout_id}/map_dependency/{map_dependency_id} |
| Get Notes | To get the list of notes. | v6, v5, v4, v3, v2.1, v2 | /Notes /Notes/{note_id} /{module_api_name}/{record_id}/Notes |
| Get Org Data | To get the organization data. | v6, v5, v4, v3, v2.1, v2 | /org |
| Get Org Img | To get the photo or logo of your organization. | v6, v5, v4, v3, v2.1, v2 | /org/photo |
| Get Pipelines | To fetch the details of all or a specific pipeline in the Deals module. | v6, v5, v4, v3, v2.1 | /settings/pipeline?layout_id={layout_id} /settings/pipeline/{pipeline_ID}?layout_id={layout_id} |
| Get Portals | To get the details of the portals available in your org. | v6, v5, v4 | /crm/{version}/settings/portals /crm/{version}/settings/portals/{portal_name} |
| Get Profiles | To retrieve the data of profiles of your organization. | v6, v5, v4, v3, v2.1, v2 | /settings/profiles /settings/profiles/{profile_id} |
| Get Records Using External ID | To fetch the records in a module using external IDs. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{external_field_value} |
| Get Records through COQL Query | To get the records from the module through a COQL query. | v6, v5, v4, v3, v2.1, v2 | /coql |
| Get Records | To retrieve the records that match your search criteria. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name} /{module_api_name}/{record_id} |
| Get Related Records using External ID | To get the related list records using external IDs. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{external_value}/{related_list_api_name} |
| Get Related Records | To get the related list records of a record. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/{related_list_api_name} |
| Get Roles | To retrieve the details about roles in your organization. | v6, v5, v4, v3, v2.1, v2 | /settings/roles /settings/roles/{role_id} |
| Get Service Preferences | To get the details of service preferences in your organization. | v6, v5, v4, v3 | /settings/service_preferences |
| Get Services | To get services data that match your search criteria. | v6, v5, v4, v3 | /Services__s /Services__s/{service_id} |
| Get Shared Record Details | To get the details of a shared record. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/actions/share |
| Get Shift Hours | To get the details of the shift hours configured for your organization. | v6, v5, v4 | /settings/business_hours/shift_hours/{shift_hour_id} |
| Get Signals | To fetch all the signals in your CRM account. | v6, v5, v4 | /settings/signals |
| Get Sources by Type | To get the details of a member of a user group by the type. | v6, v5, v4 | /settings/user_groups/{group_id}/sources |
| Get Sources Count | To get the number of users, groups, roles, and territories available in a user group. | v6, v5, v4 | /settings/user_groups/{groupid}/actions/sources_count |
| Get Tag List | To display all the tags in an organization. | v6, v5, v4, v3, v2.1, v2 | /settings/tags?module={module_api_name} |
| Get Territories of a Record | To get the details of the territories assigned to a record. | v6, v5, v4, v3, v2.1 | /{module_api_name}/{record_id} |
| Get User Groups | To get the details of the user groups created for your organization. | v6, v5, v4 | /settings/user_groups /settings/user_groups/{group_id} |
| Get User Territories | To get the territories related to a user. | v6, v5, v4, v3 | /users/{user_id}/territories /users/{user_id}/territories/{territory_id} |
| Retrieve User details Associated with a Territory | To retrieve the details of the user added to the territory in your organization. | v6 | /settings/territories/{territoryid}/users settings/territories/{territoryid}/users/{userid} |
| Get PortalUser Types | To get the user types available in a portal of your org. | v6, v5, v4 | /settings/portals/{portal_name}/user_type /settings/portals/{portal_name}/user_type/{user_type_id} |
| Get User Unavailability | To get the details of a user's unavailability. | v6, v5, v4, v3, v2.1 | /settings/users_unavailability /settings/users_unavailability/{id} |
| Get Users of a User Type | To get the list of users available in a user type of a portal. | v6, v5, v4 | /settings/portals/{portal_name}/user_type/{user_type_id}/users |
| Get Users | To retrieve the users' data specified in the API request. You can specify the type of users that needs to be retrieved. | v6, v5, v4, v3, v2.1, v2 | /users /users/{user_id} |
| Get Users Count | To fetch the user count in your org. You can get the total number of users, or get they count by user type. | v6, v5, v4, v3 | /users/actions/count |
| Get Variable Group | To get the details of any variable group. | v6, v5, v4, v3, v2.1, v2 | /settings/variable_groups/{variable_group_id (or) variable_group_API_name} |
| Get Variables | To retrieve all the available variables through an API request. | v6, v5, v4, v3, v2.1, v2 | /settings/variables /settings/variables/{variable_id}?group={variable_group_id} |
| Get Wizards | To get the details of the wizards in a module. | v6, v5, v4, v3, v2.1 | /settings/wizards /settings/wizards/{wizard_ID}?layoutid={layout_ID} |
| Insert Contact Roles | To add new contact roles. | v6, v5, v4, v3, v2.1, v2 | /Contacts/roles |
| Insert Records using External ID | To add new entities to a module using external ID. | v6, v5, v4, v3, v2.1, v2 | /{base_module_API_name} |
| Insert Records | To add new entities to a module. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name} |
| Insert Subforms | To insert a new record with subforms in a module. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name} |
| Convert Inventory Records | To convert inventory records. You can convert a record from Quotes to Sales Orders or Invoices, or from Sales Orders to Invoices. | v6 | /Quotes/{record_id}/actions/convert /Sales_Orders/{record_id}/actions/convert |
| Mass Convert Inventory Records | To mass convert inventory records. You can convert a record from Quotes to Sales Orders or Invoices, or from Sales Orders to Invoices. | v6 | /Quotes/actions/mass_convert /Sales_Orders/actions/mass_convert |
| Mass Inventory Conversion Status API | To get the status of a mass conversion job scheduled for inventory records. | v6 | /Quotes/actions/mass_convert?job_id={job_id} /Sales_Orders/actions/mass_convert?job_id={job_id} |
| Inventory Templates | To fetch the details of inventory templates. | v6, v5, v4, v3, v2.1 | /settings/inventory_templates /settings/inventory_templates/{id} |
| Invite a User to a Portal | To invite a user to a portal. | v6, v5, v4 | /{personality_module}/{record_id}/actions/portal_invite |
| Layouts Meta | To get details of the layouts associated with a particular module. | v6, v5, v4, v3, v2.1, v2 | /settings/layouts?module={module_api_name} /settings/layouts/{layout_id}?module={module_api_name} |
| Lead Conversion Options | To get the lead's conversion options before converting it to a Deal, Account, or a Contact. This API fetches the matching records from Accounts, Contacts, and Deals. This allows you to map the data correctly and avoid any duplicity while converting a lead. | v6, v5, v4, v3 | /Leads/{record_id}__conversion_options |
| Linking Modules | List of APIs supported by Linking modules. | v6, v5, v4, v3, v2.1, v2 | |
| Map Dependency | To get the details of the parent and child fields configured for a module. | v6, v5, v4 | /settings/layouts/{layout_id}/map_dependency |
| Mass Change Owner Status | To get the status of the mass change owner job scheduled previously. | v6, v5, v4 | /{module_api_name}/actions/mass_chnage_owner?job_id |
| Mass Change Owner | To change the owner of the records of a module in a particular custom view and territory in bulk. | v6, v5, v4 | /{module_api_name}/actions/mass_change_owner |
| Mass Convert Lead | To convert a maximum of up to 50 leads in a single API call. You can convert a lead with or without creating a deal through this API. | v6, v5, v4 | /Leads/actions/mass_convert |
| Lead Mass Convert Status | To get the status of the mass convert lead job scheduled previously. | v6, v5, v4 | /Leads/actions/mass_convert?job_id={job_id} |
| Mass Delete Status | To get the status of the mass delete job scheduled previously. | v6, v5, v4 | /{module_api_name}/actions/mass_delete?job_id |
| Mass Delete Records | To delete the records of a module in bulk. | v6, v5, v4 | /{module_api_name}/actions/mass_delete |
| Mass Update Records | To schedule mass update. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/actions/mass_update |
| Mass Update Status | To get the status of the mass update job scheduled previously. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/actions/mass_update?job_id |
| Meeting Cancel | To cancel a meeting and to send an email regarding the meeting cancellation to the participants. | v6, v5, v4, v3, v2.1 | /Events/{event_id}/actions/cancel |
| Merge Tags | To merge tags and put all the records under the two tags into a single tag. | v6, v5, v4, v3, v2.1, v2 | /settings/tags/{tag_id}/actions/merge |
| Module Meta | To get the metadata for a specific module. | v6, v5, v4, v3, v2.1, v2 | /settings/modules/{module_api_name} |
| Module Record Count | To fetch the total number of records in the module or the number of records that match the criteria. | v6, v5, v4, v3, v2.1 | /{module_api_name}/actions/count?criteria=(criterion_here) /{module_api_name}/actions/count?email=(email_here) /{module_api_name}/actions/count?phone=(phone_number_here) /{module_api_name}/actions/count?word=(search_word_here) |
| Modules API | To retrieve the list of all the modules available in your CRM account. | v6, v5, v4, v3, v2.1, v2 | /settings/modules |
| Notifications Disable | To stop all the instant notifications enabled by the user for a channel. | v6, v5, v4, v3, v2.1, v2 | /actions/watch |
| Notifications Enable | To enable instant notifications of actions performed on a module. | v6, v5, v4, v3, v2.1, v2 | /actions/watch |
| Get Notifications Details | To get the details of the notifications enabled by the user. | v6, v5, v4, v3, v2.1, v2 | /actions/watch |
| Disable Specific Notifications | To disable notifications for the specified events in a channel. | v6, v5, v4, v3, v2.1, v2 | /actions/watch |
| Update Details of a Notification | To update the details of the notifications enabled by a user. | v6, v5, v4, v3, v2.1, v2 | /actions/watch |
| Update Specific Information of a Notification | To update only specific details of a specific notification enabled by the user. | v6, v5, v4, v3, v2.1, v2 | /actions/watch |
| Mark a User Unavailable | To mark oneself (user) unavailable during a particular time period. | v6, v5, v4, v3, v2.1, v2 | /settings/users_unavailability |
| Update Fiscal Year Settings | To update the details of fiscal year settings of your organization. | v6, v5 | /settings/fiscal_year |
| Related List Metadata | To get the metadata of the related lists in a particular module. | v6, v5, v4, v3, v2.1, v2 | /settings/related_lists?module={module_api_name} |
| Remove Contact Role from a Specific Deal | To remove contact roles from a specific deal. | v6, v5, v4, v3, v2.1, v2 | /Deals/{deal_id}/Contact_Roles/{contact_id} /Deals/{deal_id}/Contact_Roles?ids={contact1,contact2,..} |
| Remove Tags | To delete the tags associated with records. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/actions/remove_tags /{module_api_name}/{record_id}/actions/remove_tags |
| Remove Territories of Records | To remove territories assigned to multiple records or a single record. | v6, v5, v4, v3, v2.1 | /{module_api_name}/actions/remove_territories /{module_api_name}/{record_id}/actions/remove_territories |
| Revoke Shared Record | To revoke access to a shared record that was shared to users. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/actions/share |
| Schedule Data Backup | To schedule a backup of all CRM data including attachments. | v6, v5, v4, v3 | /bulk/v5/backup |
| Get Scoring Rules | To get the list of scoring rules defined for the organization. | v6, v5, v4, v3 | /settings/automation/scoring_rules /settings/automation/scoring_rules/{rule_id} |
| Search Records Using External ID | To retrieve the records that match your search criteria using external fields. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/search |
| Search Records | To retrieve the records that match your search criteria. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/search?criteria={{criteria_here}} /{module_api_name}/search?email={{email_here}} /{module_api_name}/search?phone={{phone_number_here}} /{module_api_name}/search?word={{search_word_here}} |
| Send Mail using Merge Template | To use a mail merge template and send emails to users | v6, v5 | /{module_API_name}/{record_id}/actions/send_mail_merge |
| Send Mail | To send emails through an API. | v6, v5, v4, v3, v2.1 | /{module_api_name}/{record_id}/actions/send_mail |
| Share Record | To share a record with other users, groups, and roles in the organization. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/actions/share |
| Sign Mail Merge | To send a mail merge document for signing and approval. | v6, v5 | /{module_API_name}/{record_id}/actions/sign_mail_merge |
| Change Sort Order of Custom Views | To change the sort order of records in a custom view. | v6, v5, v4 | /settings/custom_views/{cvid}/actions/change_sort?module={module_name} /settings/custom_views/actions/change_sort?module={module_name} |
| Subforms API | To get the subform data in a record. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id} /{subform_api_name} |
| Get Record Count for a Specific Tag | To get the total number of records under a tag. | v6, v5, v4, v3, v2.1, v2 | /settings/tags/{tag_id}/actions/records_count?module={module_api_name} |
| Territories | To get the list of territories enabled for your organization. | v6, v5, v4, v3, v2.1, v2 | /settings/territories /settings/territories/{territory_id} |
| Timeline of a Record | To get the timeline of a record. The response gives you the history of the record including all the updates that were made to any of its fields and related records. | v6, v5 | /{module_API_name}/{record_ID}/__timeline |
| Transfer and Delete Pipeline | To delete a pipeline and transfer the associated stages to another pipeline. | v6, v5, v4, v3, v2.1 | /settings/pipeline/actions/transfer?layout_id={layout_ID} |
| Transfer Users and Delete Profile | To transfer the users to a new profile and delete the old one. | v6, v5 | /settings/profiles/{profile-id}?transfer_to={existing_profile_id} |
| Transfer Delete Territories | To delete territories with child territories in your organization. | v6, v5 | /settings/territories/actions/transfer_and_delete /settings/territories/{territoryid}/actions/transfer_and_delete |
| Status of Transfer Records and Delete Userss | To get the status of the "transfer records and delete user" job scheduled previously. | v6, v5 | /users/actions/transfer_and_delete?job_id={{job_id}} |
| Transfer Users and Delete Role | To delete a role and transfer the users to a new role in your organization. | v6, v5, v4, v3, v2.1 | /settings/roles/{role_id} |
| Transfer Users of a User Type | To transfer the users of a user type to another user type in a portal. | v6, v5 | /settings/portals/{portal_name}/user_type/{user_type_id}/users/action/transfer |
| Transfer Records and Delete Users | To delete user(s) from CRM and transfer the records to a new user. | v6, v5 | /users/actions/transfer_and_delete /users/{user_id}/actions/transfer_and_delete |
| Update Appointment Preferences | To update the appointment preferences in your organization. | v6, v5, v4, v3 | /settings/appointment_preferences |
| Update Appointments Rescheduled History | To update the rescheduled details of appointments. | v6, v5, v4, v3 | /Appointments_Rescheduled_History__s |
| Update Appointments | To update the details of an existing appointment in your organization. | v6, v5, v4, v3 | /Appointments__s |
| Update Blueprint Details | To update a single transition at a time. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/actions/blueprint |
| Update Business Hours | To update the details of the business hours of your org. | v6, v5 | /settings/business_hours |
| Update Contact Roles | To update details of contact roles. | v6, v5, v4, v3, v2.1, v2 | /Contacts/roles /Contacts/roles/{contact_role_id} |
| Update Currencies | To update currency details. | v6, v5, v4, v3, v2.1, v2 | /org/currencies/actions/enable /org/currencies /org/currencies/{currency_ID} |
| Update Holidays | To update the holidays set for your org. | v6, v5, v4 | /settings/holidays |
| Update Mapped Dependency Fields | To update map dependency fields on a layout of the module. | v6, v5, v4 | /settings/layouts/{layout_id}/map_dependency/{map_dependency_id} |
| Update Notes | To update an existing note. | v6, v5, v4, v3, v2.1, v2 | /Notes /Notes/{note_id} /{module_api_name}/{record_id}/Notes |
| Update Pipeline | To update a pipeline in a layout. | v6, v5, v4, v3, v2.1 | /settings/pipeline/{pipeline_ID}?layout_id={layout_id} |
| Update Portal | To update a portal's name in your org. | v6, v5, v4 | /settings/portals/{portal_name} |
| Update Profile Permission | To update the permissions of a profile. | v6, v5, v4 | /settings/profiles/{profile-id} |
| Update Records Using External ID | To update existing records in a module through an external field. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{external_field_value} |
| Update Records | To update existing entities in the module. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name} /{module_api_name}/{record_id} |
| Update Related Records using External ID | To update the related list records using external IDs. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{external_field_API_name/value}/{related_list_api_name} |
| Update Related Records | To update the relation between the records. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/{related_list_api_name}/{related_record_id} |
| Update Role | To update the details of a role in your organization. | v6, v5, v4, v3, v2.1 | /settings/roles /settings/roles/{role_id} |
| Update Scoring Rule Status | To activate or deactivate a scoring rule. | v6, v5, v4, v3 | /settings/automation/scoring_rules/{rule_id}/actions/activate /settings/automation/scoring_rules/{rule_id}/actions/activate} |
| Update Scoring Rules | To update a scoring rule. | v6, v5, v4, v3 | /settings/automation/scoring_rules /settings/automation/scoring_rules/{rule_id} |
| Update Service Preferences | To update the service preferences in your organization. | v6, v5, v4, v3 | /settings/service_preferences |
| Update Services | To update the details of an existing service in your organization. | v6, v5, v4, v3 | /Services__s |
| Update Share Permissions | Update the sharing permissions of a record granted to users, revoke access given to users, update the access permission to the related lists of the record that was shared with the user and share the record privately or publicly. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/actions/share |
| Update Shift Hours | To update the shift hours for your organization through an API. | v6, v5, v4 | /settings/business_hours/shift_hours |
| Update Subforms | To update a record with subforms in a module. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name} |
| Update Tags | To update tags and their color codes. | v6, v5, v4, v3, v2.1, v2 | /settings/tags?module={module_api_name} /settings/tags/{tag_id}?module={module_api_name} |
| Update Territories | To update the details of existing territories in your organization. | v6, v5 | /settings/territories /settings/territories/{territory_id} |
| Update User Group | To update a user group. | v6, v5, v4 | /settings/user_groups/{user_group_id} |
| Update User Type | To update the details of a user type in a portal. | v6, v5, v4 | /settings/portals/{portal_name} |
| Update User Unavailability | To update the details of your unavailability during a particular time period. | v6, v5, v4, v3, v2.1 | /settings/users_unavailability /settings/users_unavailability/{id} |
| Update User | To update the details of a user in your organization. | v6, v5, v4, v3, v2.1, v2 | /users /users/{user_id} |
| Update Variables | To update details of variables in CRM. | v6, v5, v4, v3, v2.1, v2 | /settings/variables /settings/variables/{variable_id (or) variable_api_name} |
| Upload Attachment | To attach a file to a record. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/Attachments |
| Upload Files to ZFS | To upload fields to Zoho File System. | v6, v5, v4, v3, v2.1, v2 | /files |
| Upload Image | To attach a photo to a record. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/{record_id}/photo |
| Upload Organization Image | You can upload and update the organization photo using this API. | v6, v5, v4, v3, v2.1, v2 | /org/photo |
| Upsert Records using External ID | To update existing records or insert new records in a module through an external field. | v6, v5, v4, v3, v2.1, v2 | /{module_api_name}/upsert |
| Insert or Update Records (Upsert) | To insert or update a record. The system checks for duplicate records based on the duplicate check field's values. If the record is already present, it gets updated. If not, the record is inserted. | v5, v5, v4, v3, v2.1, v2 | /{module_api_name}/upsert |
| User Groups Associations | You can associate a user group with sharing rules, workflows, assignment rules, approval and review processes, and email notification criteria. Use this API to find out where a user group is associated. | v6, v5 | /settings/user_groups/{user_group_ID}/actions/associations |
| Validate Before Transfer | To validate whether or not the user has open records(records with open cases, tasks, calls, or meetings) in a territory before transferring them to a user in another territory. | v6, v5, v4, v3 | /users/{user_id}/territories/actions/validate_before_transfer /users/{user |