Skip to main content

Select API Scopes

API Scopes
  • Manage and manipulate your org information.
  • Retrieve specific or all CRM metadata.
  • Create and manage users and their access in your Zoho CRM org.

    Additional Scopes Required:

  • Create and use various templates in your org.
  • Perform actions on Zoho CRM modules.

    Additional Scopes Required:

  • Create a mass convert job and retrieve its status.
  • Update bulk records and retrieve their status.
  • Delete records in bulk, and get the status of the jobs.
  • Create and share records with other users in the org.
  • To send mails 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:

    • 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:

    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 TypeDescription
    ALLFull access to the resource
    READAllow access to read data from the resource
    CREATEAllow access to create data in the resource
    UPDATEAllow access to update an existing data in the resource
    WRITE Allow access to edit data in the resource (Alias for CREATE, UPDATE, and DELETE)
    DELETEAllow access to delete data in the resource
    CUSTOMCustom Operation Type