Select API Scopes
- Manage and manipulate your org information.
- Retrieve specific or all CRM metadata.
- Access and manipulate field metadata for different modules in the CRM org.
- Access and manipulate the metadata of a layout for a specific module.
- Manipulate the metadata of a specific module or all modules.
- Access and manage profiles in your Zoho CRM.
- To access and manipulate custom view metadata.
- Manipulate and manage roles in your Zoho CRM.
- Access and manipulate territories metadata.
Additional Scopes Required:
- Associated User Count : ZohoCRM.settings.territories.All and ZohoCRM.users.All
- Disassociate Users from Territory : ZohoCRM.settings.territories.All or ZohoCRM.settings.territories.DELETE (and) ZohoCRM.users.All
- To access, manipulate and activate/deactivate scoring rules.
- Retrieve all the signals in your Zoho CRM account.
- Manipulate Zoho CRM variables.
- Retrieve variable group metadata.
- Configure and manage dependencies between CRM fields.
- Access and manipulate user group metadata.
Additional Scopes Required:
- Associated Groups of a User : ZohoCRM.settings.user_groups.ALL/READ and ZohoCRM.users.ALL/READ
- To access and manipulate pipelines.
- Retrieve wizards' information within a module.
- Retrieve the details of assignment rules in your org.
- Create and manage client portals for your org.
- Retrieve and update fiscal year data in your org.
- Manipulate locking configuration for different modules.
- Manipulate business hours data for your CRM org.
- Create and manage currencies within your Zoho CRM.
Additional Scopes Required:
- Enable multiple currencies : ZohoCRM.settings.currencies.CREATE
- Retrieve email settings in your org.
- Access and use mail merge templates.
Additional Scopes Required:
- To send mail merge : ZohoCRM.settings.mailmerge.CREATE, ZohoWriter.documentEditor.ALL, ZohoWriter.merge.ALL, ZohoCRM.settings.emails.ALL
- To sign mail merge : ZohoCRM.settings.mailmerge.CREATE, ZohoWriter.documentEditor.ALL, ZohoWriter.merge.ALL, ZohoSign.documents.ALL
- To download mail merge : ZohoCRM.settings.mailmerge.CREATE, ZohoWriter.documentEditor.ALL, ZohoWriter.merge.ALL
- Access and manage unsubscribe links, and their associations.
- Create and manage global picklists across all the modules.
- Manage and permanently delete records from the Recycle Bin in your Zoho CRM.
- Create and manage users and their access in your Zoho CRM org.
Additional Scopes Required:
- Get Associated User Count : ZohoCRM.settings.territories.All and ZohoCRM.users.All
- Associate Users with Territory : ZohoCRM.settings.territories.All and ZohoCRM.users.All
- Associated Groups of a User : ZohoCRM.settings.user_groups.ALL/READ and ZohoCRM.users.ALL/READ
- Create and use various templates in your org.
- Retrieve the email templates in your org.
- Retrieve the inventory templates in your org.
- Perform actions on Zoho CRM modules.
Additional Scopes Required:
- Search Records : ZohoCRM.modules.{module_name}.{operation_type} and ZohoSearch.securesearch.READ
- Record Count in a Module : ZohoCRM.modules.{module_name}.{operation_type} and ZohoSearch.securesearch.READ
- Search Records Using External ID : ZohoCRM.modules.all or ZohoCRM.modules.{module_name}.{operation_type} and ZohoSearch.securesearch.READ
- Contact Roles of a Specific Deal : ZohoCRM.modules.ALL or ZohoCRM.modules.contacts.{operation_type} and ZohoCRM.modules.deals.{operation_type}
- Add Contact Roles to a Specific Deal : ZohoCRM.modules.ALL or ZohoCRM.modules.deals.{operation_type} and ZohoCRM.modules.contacts.{operation_type}
- Remove Contact Role from a Specific Deal : ZohoCRM.modules.ALL or ZohoCRM.modules.deals.DELETE and ZohoCRM.modules.contacts.DELETE
- Entity Score : ZohoCRM.modules.entity_scores.READ and ZohoCRM.modules.{module_name}.{operation_type}
- Create Notes, Read Notes, Update Notes, Delete Notes : ZohoCRM.modules.ALL or ZohoCRM.modules.{module_name}.{operation_type} and ZohoCRM.modules.notes.{operation_type}
- List of Attachments, Upload an Attachment, Download an Attachment, Delete an Attachment : ZohoCRM.modules.ALL or ZohoCRM.modules.{module_name}.{operation_type} and ZohoCRM.modules.attachments.{operation_type}
- Associate Email with a Record : ZohoCRM.modules.emails.ALL and ZohoCRM.modules.{module_name}.ALL
- Download Email Attachments, Download Inline Images of an Email, Get Email Shared Details, Get Emails of a Record : ZohoCRM.modules.READ or ZohoCRM.modules.{module_name}.READ and ZohoCRM.modules.emails.READ
- Lead Conversion Options : ZohoCRM.modules.ALL or ZohoCRM.modules.leads.READ
- Convert Lead : ZohoCRM.modules.ALL or ZohoCRM.modules.leads.CREATE
- Merge Records : ZohoCRM.modules.ALL or ZohoCRM.modules.leads.CREATE
- Create and manage records in the Leads module.
- Create and manage account records in the Accounts module.
- Create and manage contact records in the Contacts module.
- Retrieve the entity score of a record in a module.
- Create and manage records in the Deals module.
- Create and manage records in the custom modules.
- Create and manage records in the Campaigns module.
- Create and manage records in the Tasks module.
- Create and manage records in the Cases module.
- Create and manage records in the Calls module.
- Create and manage records in the Calls module.
- Create and manage records in the Meetings module.
- Create and manage records in the Solutions module.
- Create and manage records in the Product module.
- Create and manage records in the Vendors module.
- Create and manage records in the Pricebooks module.
- Create and manage records in the Quotes module.
- Create and manage records in the Salesorders module.
- Create and manage Purchase orders.
- Create and manage records in the Invoices module.
- Create and manage records in the Appointments module.
- Create and manage records in the Appointments Rescheduled History module.
- Create and manage records in the Services module.
- Create and manage Notes.
- Create and manage attachments.
- Create, associate, and retrieve emails in Zoho CRM.
- Create a mass convert job and retrieve its status.
- Convert multiple records in the Leads module to a specified module and retrieve the status of the job.
- Convert multiple records in the Quotes module to a specified module and retrieve the status.
- Convert multiple records in the Salesorders module to a specified module and retrieve the status of conversion job.
- Update bulk records and retrieve their status.
- Update bulk records and retrieve their job status in the Leads module.
- Update bulk records and retrieve their job status in the Contacts module.
- Update bulk records and retrieve their job status in the Contacts module.
- Update bulk records and retrieve their job status in the Deals module.
- Update bulk records and retrieve their job status in the Campaigns module.
- Update bulk records and retrieve their job status in the Calls module.
- Update bulk records and retrieve their job status in the Meetings module.
- Update bulk records and retrieve their job status in the Tasks module.
- Update bulk records and retrieve their job status in the Solutions module.
- Update bulk records and retrieve their job status in the Products module.
- Update bulk records and retrieve their job status in the Vendors module.
- Update bulk records and retrieve their job status in the Price Books module.
- Update bulk records and retrieve their job status in the Quotes module.
- Update bulk records and retrieve their job status in the Sales Orders module.
- Update bulk records and retrieve their job status in the Purchase Orders module.
- Update bulk records and retrieve their job status in the Invoices module.
- Update bulk records and retrieve their job status in the Custom module.
- Delete records in bulk, and get the status of the jobs.
- Delete bulk records and retrieve their job status in the Leads module.
- Delete bulk records and retrieve their job status in the Accounts module.
- Delete bulk records and retrieve their job status in the Contacts module.
- Delete bulk records and retrieve their job status in the Deals module.
- Delete bulk records and retrieve their job status in the Campaigns module.
- Delete bulk records and retrieve their job status in the Tasks module.
- Delete bulk records and retrieve their job status in the Cases module.
- Delete bulk records and retrieve their job status in the Events module.
- Delete bulk records and retrieve their job status in the Calls module.
- Delete bulk records and retrieve their job status in the Solutions module.
- Delete bulk records and retrieve their job status in the Products module.
- Delete bulk records and retrieve their job status in the Vendors module.
- Delete bulk records and retrieve their job status in the Price Books module.
- Delete bulk records and retrieve their job status in the Quotes module.
- Delete bulk records and retrieve their job status in the Sales Orders module.
- Delete bulk records and retrieve their job status in the Purchase Orders module.
- Delete bulk records and retrieve their job status in the Invoices module.
- Delete bulk records and retrieve their job status in the Services module.
- Delete bulk records and retrieve their job status in the Appointments module.
- Delete bulk records and retrieve their job status in the Custom module.
- To send mails via an API.
- You can send mail from all modules
- To send mails to the records in the Leads module via an API.
- To send mails to the records in the Accounts module via an API.
- To send mails to the records in the Contacts module via an API.
- To send mails to the records in the Deals module via an API.
- To send mails to the records in the Quotes module via an API.
- To send mails to the records in the Salesorders module via an API.
- To send mails to the records in the Purchaseorders module via an API.
- To send mails to the records in the Invoices module via an API.
- To send mails to the records in the Cases module via an API.
- To send mails to the records in a custom module via an API.
- To update the owner details of records.
- Upload and retrieve files in your Zoho CRM.
- Perform bulk actions with the multiple records in a module in your Zoho CRM.
Additional Scopes Required:
- Create Bulk Read job (Bulk Export) : ZohoCRM.bulk.read and ZohoCRM.modules.{module_name}.{operation_type}
- Create Bulk Write Job : ZohoCRM.bulk.CREATE or ZohoCRM.bulk.ALL and ZohoCRM.modules.ALL or ZohoCRM.modules.{module_name}.{operation_type}
- Upload File, Backed up Data : ZohoFiles.files.ALL
- Perform bulk data backup operation in your Zoho CRM.
- Retrieve information about the features and their limits in your org.
- Perform a composite API call, consisting of one or up to five sub-requests.
Additional Scopes Required:
- Composite API : ZohoCRM.composite_requests.CUSTOM (and) Scope of the subrequest
- Create and manage notifications in Zoho CRM.
- To retrieve records using Zoho CRM's Custom Object Query Language (COQL).
Additional Scopes Required:
- Records through a COQL Query : ZohoCRM.coql.READ and ZohoCRM.modules.all or ZohoCRM.modules.{module_name}.{operation_type}
Note
The Activities module was deprecated in V3. If you make API calls to the Activities module using ZohoCRM.modules.Activities.{operation_type}, the system will return an OAUTH_SCOPE_MISMATCH error. Instead you can make module-specific API calls for Meetings, Calls, and Tasks from V3.
| Operation Type | Description |
|---|---|
| ALL | Full access to the resource |
| READ | Allow access to read data from the resource |
| CREATE | Allow access to create data in the resource |
| UPDATE | Allow access to update an existing data in the resource |
| WRITE | Allow access to edit data in the resource (Alias for CREATE, UPDATE, and DELETE) |
| DELETE | Allow access to delete data in the resource |
| CUSTOM | Custom Operation Type |