Integrations
Zoho CRM
Set up Zoho CRM OAuth for records, settings, and email in any Zoho data center
Overview
Section titled “Overview”Connect end users’ Zoho CRM accounts for leads, contacts, deals, and every other CRM module, plus CRM settings, users, and email. Users in any supported Zoho data center can connect through one Zoho client.
| Property | Value |
|---|---|
| Provider ID | zoho |
| Category | CRM |
| PKCE | Supported |
| Token refresh | Automatic |
| Redirect URI | Shown in Developer Portal |
Step 1: Create a Zoho API Console client
Section titled “Step 1: Create a Zoho API Console client”Go to the Zoho API Console
Sign in to the Zoho API Console with a Zoho account in the US data center (accounts.zoho.com), click Add Client, and choose Server-based Applications.
Create the client
Enter a Client Name and Homepage URL, paste the Alter callback URL from the Developer Portal into Authorized Redirect URIs, and click Create.
Get credentials
Open the Client Secret tab and copy the Client ID and Client Secret.
Enable data centers
Open the Settings tab and turn on every data center your users’ Zoho accounts are in. Also turn on Use the same OAuth credentials for all data centers: Alter sends one Client Secret to every data center, and a data center with its own secret rejects it.
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”Open the Developer Portal
Go to portal.alterauth.com and navigate to the application.
Add Zoho CRM provider
Go to OAuth Providers > Add Provider > Zoho CRM.
Enter credentials
- Client ID: the Zoho client’s Client ID
- Client Secret: the Zoho client’s Client Secret
Select scopes
Choose the scopes the application needs. openid and email are always requested: Zoho returns the user’s identity only with them.
Save
Click Save. Alter checks the Client ID and Client Secret with Zoho’s US accounts server, and a pair Zoho rejects fails the save. Any other answer saves with the credentials reported as not verified; the first connect then checks them.
Data centers
Section titled “Data centers”Each Zoho account lives in one data center. Consent always starts at accounts.zoho.com; Zoho moves a user whose account is elsewhere to their own data center and tells Alter which one when it returns the user. Alter exchanges the code, and refreshes the token for as long as the connection lives, at that data center’s accounts server.
Supported data centers: United States, Europe, India, Australia, Japan, Canada, Saudi Arabia, United Kingdom, United Arab Emirates, and Singapore. Zoho’s China data center (accounts.zoho.com.cn) is a separate Zoho realm whose consent must start there, and is not supported. A connect that names any other data center fails.
Using in Code
Section titled “Using in Code”Zoho serves each data center’s API from its own domain (https://www.zohoapis.com, https://www.zohoapis.eu, …). Alter records the connected account’s API domain and returns it on the grant as api_base_url / apiBaseUrl; build CRM URLs from it:
page = await app.list_grants(end_user_token=end_user_token, provider_id="zoho")grant = next(g for g in page.grants if g.grant_kind == "oauth")
response = await app.request( HttpMethod.GET, f"{grant.api_base_url}/crm/v8/Leads", grant_id=grant.grant_id, query_params={"fields": "Last_Name,Email"},)Sandbox and developer orgs
Section titled “Sandbox and developer orgs”A Zoho CRM sandbox or developer org connects through the same Zoho client and the same accounts servers as a production org. When the user’s account has more than one org, Zoho asks during consent which one (Production, Sandbox or Developer) the application may access. Zoho then returns that org’s API domain (https://sandbox.zohoapis.eu, https://developer.zohoapis.com.au, …), which Alter returns as api_base_url, so the code above reaches the right org unchanged. Tokens are specific to the org they were issued for (Zoho CRM access and refresh tokens). Because sandbox orgs share the production OAuth servers, a Zoho CRM configuration has no sandbox environment to select.
Alter sends the access token as Authorization: Zoho-oauthtoken <token>, the scheme the CRM API requires. A token fetched for direct use carries the same format in its injection details.
A call that needs a scope the connection lacks comes back from Zoho as 401 with OAUTH_SCOPE_MISMATCH. Alter returns it to the caller as Zoho’s response and does not treat it as a revoked connection; only a rejected access token marks the connection for reconnect.
The connected account
Section titled “The connected account”Alter records the connection as the Zoho user’s sub from the ID token Zoho returns (openid and email), with their email address as the account identifier. Reconnecting the same Zoho user reuses its connection.
Policy
Section titled “Policy”Every call made with a Zoho CRM grant runs through Alter’s policy rules: method and endpoint restrictions, IP allowlists, time windows, quotas, human approval, AI review, and content rules that deny, redact, or require step-up. Rules can be attached to the organization, the application, an agent, a grant, an end user, or the Zoho CRM provider configuration. Content rules can name a Zoho CRM operation from the table below, a family, or a request field:
| Family | Zoho CRM operations it covers |
|---|---|
read | Every GET, plus the read-only POST calls: COQL queries, bulk search, related-record counts, mail merge downloads, bulk read jobs, and audit log exports |
write | Every create and update |
delete | Every DELETE, plus mass delete, mass tag delete, emptying the recycle bin, the transfer-and-delete calls (pipelines, territories, users), and merging records (the merged records are deleted) |
send | Calls that themselves email or notify a person: sending an email, sending a mail merge email or a document for signature, cancelling a meeting (which can mail its participants), portal and user invitations, enrolling records in a cadence, owner changes and lead conversions (which can notify the owners), sharing a record (which can notify its members), record creates and updates (a Tasks or Events record saved with send_notification emails its participants), and appointments (their reminders) |
admin | Every write under /crm/v8/settings/, /crm/v8/org/, and /crm/v8/users/, plus creating and updating users, organization photo changes, notification channels (which push every change to a URL), record sharing, portal invitations, and the reads of webhooks, variables, and notification channels, which return the URLs, parameters, and tokens an administrator configured |
createCompositeRequest (POST /crm/v8/__composite_requests) runs the sub-requests its body lists, so it carries every family but payment.
Typical rules:
- Require human approval for the
sendfamily, so no email or invitation a call sends reaches a person without approval. - Deny the
adminfamily on agent grants. - Restrict a grant to
GETon/crm/v8/Leads*for a read-only reporting agent.
Sending an email (sendMail) projects a recipients parameter that folds every address it is delivered to (data[*].to[*].email, data[*].cc[*].email, data[*].bcc[*].email), so a rule such as “require approval when recipients fall outside @example.com” judges all of them. A mail merge send addresses the record’s own email when the body names no to_address, so it projects no recipients and a rule that names them refuses it.
The scope a Zoho CRM call needs depends on the module in its path (ZohoCRM.modules.leads.READ for /crm/v8/Leads), so Alter does not map Zoho operations to scopes. A grant narrowed to some Zoho scopes refuses, with scope_narrowing_unenforceable, every call that a method and endpoint restriction attached to the grant or agent does not pin; narrow Zoho grants with policy rules instead.
Use alter policy simulate or Explain a request in the Developer Portal to see which operation and family a Zoho CRM request classifies as. See Policies and Set policies.
- Access tokens last one hour. Refresh tokens do not expire until the user revokes them; Alter refreshes automatically.
- Zoho keeps at most 20 refresh tokens per user and client, and every connect issues a new one: a user who connects more than 20 times invalidates their oldest connection.
- Zoho has no revocation call Alter makes. Disconnecting in Alter removes Alter’s copy of the tokens; the user removes the app under Zoho Accounts → Connected Apps to cut off its access there.
- Alter’s policy catalog covers Zoho’s official CRM v8 API documents. A route outside it (another API version, or a Zoho product other than CRM) is unclassified, so a rule that names operations or families refuses it. The file upload API (
upload.zoho.com) is not reachable through this provider. - See the Zoho OAuth documentation for more details.
Available Scopes
Section titled “Available Scopes”The scopes a Zoho CRM client can request: the OpenID Connect scopes, every scope on Zoho’s CRM scopes reference, and every scope Zoho’s CRM v8 API documents name for an operation, in the scopes reference’s spelling. Scopes marked Requested by default are requested when a connection names no scopes.
| Scope | Description |
|---|---|
openid | Always requested. The user’s unique Zoho identifier, the connection’s account |
email | Always requested. The user’s email address and whether Zoho verified it |
profile | Requested by default. The user’s profile information, such as their name |
ZohoCRM.apis.READ | Read apis. Used by: List available REST APIs |
ZohoCRM.bulk.ALL | Full access to bulk |
ZohoCRM.bulk.CREATE | Create bulk. Used by: Create a bulk write job; Get bulk write job details |
ZohoCRM.bulk.READ | Read bulk. Used by: Create a bulk read job; Download bulk read result; Get bulk read job details |
ZohoCRM.change_owner.CREATE | Create change owner. Used by: Change Owner; Submit mass change owner job; Transfer a user |
ZohoCRM.change_owner.READ | Read change owner. Used by: Get mass change owner job status; Get user transfer status; Validate user before transfer |
ZohoCRM.composite_requests.CUSTOM | Use composite requests. Used by: Process multiple API requests in a single call |
ZohoCRM.coql.READ | Read coql. Used by: Retrieve records using a COQL query |
ZohoCRM.features.READ | Read features. Used by: Features; Specific Feature; User Licenses Feature |
ZohoCRM.files.CREATE | Create files. Used by: Upload files to ZFS |
ZohoCRM.files.READ | Read files. Used by: Retrieve a file from ZFS |
ZohoCRM.mass_convert.leads.CREATE | Create mass convert leads. Used by: Submit mass convert job for leads |
ZohoCRM.mass_convert.leads.READ | Read mass convert leads. Used by: Get mass convert job status |
ZohoCRM.mass_delete.DELETE | Delete mass delete. Used by: Delete records in bulk by record IDs or Custom View |
ZohoCRM.mass_delete.READ | Read mass delete. Used by: Retrieve mass delete job status |
ZohoCRM.mass_update.leads.READ | Read mass update leads. Used by: Get mass update job status |
ZohoCRM.mass_update.leads.UPDATE | Update mass update leads. Used by: Mass update records |
ZohoCRM.mass_update.READ | Read mass update. Used by: Get mass update job status |
ZohoCRM.mass_update.UPDATE | Update mass update. Used by: Mass update records |
ZohoCRM.modules.accounts.ALL | Full access to accounts records |
ZohoCRM.modules.accounts.CREATE | Create accounts records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Merge Records |
ZohoCRM.modules.accounts.DELETE | Delete accounts records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.accounts.READ | Read accounts records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Merge Job Status; Get Timelines |
ZohoCRM.modules.accounts.UPDATE | Update accounts records. Used by: Unblock email for a single record; Unblock emails for multiple records in a module; Update Email Drafts for a Record |
ZohoCRM.modules.activities.ALL | Full access to activities records |
ZohoCRM.modules.activities.CREATE | Create activities records. Used by: Share Record Emails |
ZohoCRM.modules.activities.DELETE | Delete activities records. Used by: Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.activities.READ | Read activities records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Search Records by Criteria, Word, Email, or Phone |
ZohoCRM.modules.activities.UPDATE | Update activities records |
ZohoCRM.modules.ALL | Full access to records in every module. Used by: Add Tags to Records; Add Tags to a Record; Create a bulk read job |
ZohoCRM.modules.appointments.ALL | Full access to appointments records |
ZohoCRM.modules.appointments.CREATE | Create appointments records. Used by: Create Appointment records |
ZohoCRM.modules.appointments.DELETE | Delete appointments records. Used by: Delete an Appointment by ID; Delete one or more appointment records |
ZohoCRM.modules.appointments.READ | Read appointments records. Used by: Get Appointment Records; Get an Appointment Record by ID |
ZohoCRM.modules.appointments.UPDATE | Update appointments records. Used by: Update an Appointment Record by ID; Update appointment records |
ZohoCRM.modules.appointments_rescheduled_history.ALL | Full access to appointments rescheduled history records |
ZohoCRM.modules.appointments_rescheduled_history.CREATE | Create appointments rescheduled history records |
ZohoCRM.modules.appointments_rescheduled_history.DELETE | Delete appointments rescheduled history records |
ZohoCRM.modules.appointments_rescheduled_history.READ | Read appointments rescheduled history records |
ZohoCRM.modules.appointments_rescheduled_history.UPDATE | Update appointments rescheduled history records |
ZohoCRM.modules.approvals.ALL | Full access to approvals records |
ZohoCRM.modules.approvals.CREATE | Create approvals records |
ZohoCRM.modules.approvals.DELETE | Delete approvals records |
ZohoCRM.modules.approvals.READ | Read approvals records |
ZohoCRM.modules.approvals.UPDATE | Update approvals records |
ZohoCRM.modules.attachments.ALL | Full access to attachments records. Used by: Delete Link Attachment; Retrieve All Attachments; Upload an Attachment |
ZohoCRM.modules.attachments.CREATE | Create attachments records. Used by: Share Record Emails; Upload an Attachment |
ZohoCRM.modules.attachments.DELETE | Delete attachments records. Used by: Delete Link Attachment; Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.attachments.READ | Read attachments records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Download a specific attachment file; Retrieve All Attachments |
ZohoCRM.modules.calls.ALL | Full access to calls records |
ZohoCRM.modules.calls.CREATE | Create calls records. Used by: Share Record Emails |
ZohoCRM.modules.calls.DELETE | Delete calls records. Used by: Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.calls.READ | Read calls records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count |
ZohoCRM.modules.calls.UPDATE | Update calls records |
ZohoCRM.modules.campaigns.ALL | Full access to campaigns records |
ZohoCRM.modules.campaigns.CREATE | Create campaigns records. Used by: Share Record Emails |
ZohoCRM.modules.campaigns.DELETE | Delete campaigns records. Used by: Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.campaigns.READ | Read campaigns records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count |
ZohoCRM.modules.campaigns.UPDATE | Update campaigns records |
ZohoCRM.modules.cases.ALL | Full access to cases records |
ZohoCRM.modules.cases.CREATE | Create cases records. Used by: Create Email Drafts for a Record; Share Record Emails |
ZohoCRM.modules.cases.DELETE | Delete cases records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.cases.READ | Read cases records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Get an Email Draft |
ZohoCRM.modules.cases.UPDATE | Update cases records. Used by: Unblock email for a single record; Unblock emails for multiple records in a module; Update Email Drafts for a Record |
ZohoCRM.modules.contacts.ALL | Full access to contacts records. Used by: Download an inline image from an email |
ZohoCRM.modules.contacts.CREATE | Create contacts records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Link Deal Email |
ZohoCRM.modules.contacts.DELETE | Delete contacts records. Used by: Deal Contact Roles; Delete Contact Roles; Delete a Contact Role |
ZohoCRM.modules.contacts.READ | Read contacts records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Deal Contact Roles; Get Merge Job Status |
ZohoCRM.modules.contacts.UPDATE | Update contacts records. Used by: Deal Contact Roles; Unblock email for a single record; Unblock emails for multiple records in a module |
ZohoCRM.modules.contacts.WRITE | Write contacts records. Used by: Create Contact Roles |
ZohoCRM.modules.CREATE | Create records in every module. Used by: Convert a Lead; Create or update records in a specified module; Create records in a specified module |
ZohoCRM.modules.custom.ALL | Full access to custom records |
ZohoCRM.modules.custom.CREATE | Create custom records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Merge Records |
ZohoCRM.modules.custom.DELETE | Delete custom records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.custom.READ | Read custom records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Merge Job Status; Get Timelines |
ZohoCRM.modules.custom.UPDATE | Update custom records. Used by: Unblock email for a single record; Unblock emails for multiple records in a module; Update Email Drafts for a Record |
ZohoCRM.modules.dashboards.ALL | Full access to dashboards records |
ZohoCRM.modules.dashboards.CREATE | Create dashboards records |
ZohoCRM.modules.dashboards.DELETE | Delete dashboards records |
ZohoCRM.modules.dashboards.READ | Read dashboards records |
ZohoCRM.modules.dashboards.UPDATE | Update dashboards records |
ZohoCRM.modules.deals.ALL | Full access to deals records. Used by: Download an inline image from an email |
ZohoCRM.modules.deals.CREATE | Create deals records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Link Deal Email |
ZohoCRM.modules.deals.DELETE | Delete deals records. Used by: Deal Contact Roles; Delete an Email Draft; Unshare Record Emails |
ZohoCRM.modules.deals.READ | Read deals records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Deal Contact Roles; Get Timelines |
ZohoCRM.modules.deals.UPDATE | Update deals records. Used by: Deal Contact Roles; Unblock email for a single record; Unblock emails for multiple records in a module |
ZohoCRM.modules.DELETE | Delete records in every module. Used by: Delete a record photo; Delete a specific record by ID; Delete records from a specified module |
ZohoCRM.modules.emails.CREATE | Create emails records. Used by: Associate Email; Link Deal Email; Link Emails to Deals |
ZohoCRM.modules.emails.READ | Read emails records. Used by: Download an email attachment; Download an inline image from an email; Get email sharing details for a record |
ZohoCRM.modules.events.ALL | Full access to events records |
ZohoCRM.modules.events.CREATE | Create events records. Used by: Share Record Emails |
ZohoCRM.modules.events.DELETE | Delete events records. Used by: Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.events.READ | Read events records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count |
ZohoCRM.modules.events.UPDATE | Update events records. Used by: Cancel a Meeting |
ZohoCRM.modules.forecasts.CREATE | Create forecasts records. Used by: Share Record Emails |
ZohoCRM.modules.forecasts.DELETE | Delete forecasts records. Used by: Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.forecasts.READ | Read forecasts records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Search Records by Criteria, Word, Email, or Phone |
ZohoCRM.modules.invoices.ALL | Full access to invoices records |
ZohoCRM.modules.invoices.CREATE | Create invoices records. Used by: Create Email Drafts for a Record; Share Record Emails |
ZohoCRM.modules.invoices.DELETE | Delete invoices records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.invoices.READ | Read invoices records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get an Email Draft; List Email Drafts for a Record |
ZohoCRM.modules.invoices.UPDATE | Update invoices records. Used by: Update Email Drafts for a Record; Update an Email Draft |
ZohoCRM.modules.leads.ALL | Full access to leads records. Used by: Download an inline image from an email |
ZohoCRM.modules.leads.CREATE | Create leads records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Merge Records |
ZohoCRM.modules.leads.DELETE | Delete leads records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.leads.READ | Read leads records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Download an email attachment; Get Merge Job Status |
ZohoCRM.modules.leads.UPDATE | Update leads records. Used by: Unblock email for a single record; Unblock emails for multiple records in a module; Update Email Drafts for a Record |
ZohoCRM.modules.notes.ALL | Full access to notes records |
ZohoCRM.modules.notes.CREATE | Create notes records. Used by: Create Notes; Related Notes; Share Record Emails |
ZohoCRM.modules.notes.DELETE | Delete notes records. Used by: Delete a Specific Note; Notes; Related Note |
ZohoCRM.modules.notes.READ | Read notes records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get a Specific Note; Notes |
ZohoCRM.modules.notes.UPDATE | Update notes records. Used by: Related Note; Related Notes; Update Notes |
ZohoCRM.modules.potentials.CREATE | Create potentials records. Used by: Merge Records |
ZohoCRM.modules.potentials.READ | Read potentials records. Used by: Get Merge Job Status |
ZohoCRM.modules.pricebooks.ALL | Full access to pricebooks records |
ZohoCRM.modules.pricebooks.CREATE | Create pricebooks records |
ZohoCRM.modules.pricebooks.DELETE | Delete pricebooks records |
ZohoCRM.modules.pricebooks.READ | Read pricebooks records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count |
ZohoCRM.modules.pricebooks.UPDATE | Update pricebooks records |
ZohoCRM.modules.products.ALL | Full access to products records |
ZohoCRM.modules.products.CREATE | Create products records. Used by: Share Record Emails |
ZohoCRM.modules.products.DELETE | Delete products records. Used by: Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.products.READ | Read products records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count |
ZohoCRM.modules.products.UPDATE | Update products records |
ZohoCRM.modules.purchaseorders.ALL | Full access to purchaseorders records |
ZohoCRM.modules.purchaseorders.CREATE | Create purchaseorders records. Used by: Create Email Drafts for a Record |
ZohoCRM.modules.purchaseorders.DELETE | Delete purchaseorders records. Used by: Delete an Email Draft |
ZohoCRM.modules.purchaseorders.READ | Read purchaseorders records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Get an Email Draft |
ZohoCRM.modules.purchaseorders.UPDATE | Update purchaseorders records. Used by: Unblock email for a single record; Unblock emails for multiple records in a module; Update Email Drafts for a Record |
ZohoCRM.modules.quotes.ALL | Full access to quotes records |
ZohoCRM.modules.quotes.CREATE | Create quotes records. Used by: Convert Inventory Record; Create Email Drafts for a Record; Enroll Records to Cadences |
ZohoCRM.modules.quotes.DELETE | Delete quotes records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.quotes.READ | Read quotes records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Get an Email Draft |
ZohoCRM.modules.quotes.UPDATE | Update quotes records. Used by: Unblock email for a single record; Unblock emails for multiple records in a module; Update Email Drafts for a Record |
ZohoCRM.modules.READ | Requested by default. Read records in every module. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get a record by ID from a specified module; Get a record photo |
ZohoCRM.modules.salesorders.ALL | Full access to salesorders records |
ZohoCRM.modules.salesorders.CREATE | Create salesorders records. Used by: Convert Inventory Record; Create Email Drafts for a Record |
ZohoCRM.modules.salesorders.DELETE | Delete salesorders records. Used by: Delete an Email Draft |
ZohoCRM.modules.salesorders.READ | Read salesorders records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Get an Email Draft |
ZohoCRM.modules.salesorders.UPDATE | Update salesorders records. Used by: Unblock email for a single record; Unblock emails for multiple records in a module; Update Email Drafts for a Record |
ZohoCRM.modules.search.ALL | Full access to search records |
ZohoCRM.modules.search.CREATE | Create search records |
ZohoCRM.modules.search.DELETE | Delete search records |
ZohoCRM.modules.search.READ | Read search records |
ZohoCRM.modules.search.UPDATE | Update search records |
ZohoCRM.modules.services.ALL | Full access to services records |
ZohoCRM.modules.services.CREATE | Create services records. Used by: Create service records in Zoho CRM |
ZohoCRM.modules.services.DELETE | Delete services records. Used by: Delete a service record by ID; Delete one or more service records |
ZohoCRM.modules.services.READ | Read services records. Used by: Get services; Retrieve a specific service record by ID |
ZohoCRM.modules.services.UPDATE | Update services records. Used by: Update a specific service record by ID; Update service records |
ZohoCRM.modules.solutions.ALL | Full access to solutions records |
ZohoCRM.modules.solutions.CREATE | Create solutions records. Used by: Share Record Emails |
ZohoCRM.modules.solutions.DELETE | Delete solutions records. Used by: Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.solutions.READ | Read solutions records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count |
ZohoCRM.modules.solutions.UPDATE | Update solutions records |
ZohoCRM.modules.tasks.ALL | Full access to tasks records |
ZohoCRM.modules.tasks.CREATE | Create tasks records. Used by: Share Record Emails |
ZohoCRM.modules.tasks.DELETE | Delete tasks records. Used by: Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.tasks.READ | Read tasks records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count |
ZohoCRM.modules.tasks.UPDATE | Update tasks records |
ZohoCRM.modules.UPDATE | Update records in every module. Used by: Assign territories to a record; Assign territories to multiple records; Remove territories from a record |
ZohoCRM.modules.vendors.ALL | Full access to vendors records |
ZohoCRM.modules.vendors.CREATE | Create vendors records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Merge Records |
ZohoCRM.modules.vendors.DELETE | Delete vendors records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk |
ZohoCRM.modules.vendors.READ | Read vendors records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Merge Job Status; Get Timelines |
ZohoCRM.modules.vendors.UPDATE | Update vendors records. Used by: Update Email Drafts for a Record; Update an Email Draft |
ZohoCRM.notifications.ALL | Full access to notifications. Used by: Create notification channels; Disable notification channels; Update full notification details |
ZohoCRM.notifications.CREATE | Create notifications. Used by: Create notification channels |
ZohoCRM.notifications.DELETE | Delete notifications. Used by: Disable notification channels |
ZohoCRM.notifications.READ | Read notifications. Used by: List active notification channels |
ZohoCRM.notifications.UPDATE | Update notifications. Used by: Update full notification details; Update notification channel information |
ZohoCRM.org.ALL | Full access to org |
ZohoCRM.org.CREATE | Create org. Used by: Upload Organization Photo |
ZohoCRM.org.DELETE | Delete org. Used by: Delete the organization photo |
ZohoCRM.org.READ | Requested by default. Read org. Used by: Get organization details; Organization photo |
ZohoCRM.send_mail.all.CREATE | Create send mail all. Used by: Send an email to a record |
ZohoCRM.settings.ALL | Full access to settings. Used by: Related Lists |
ZohoCRM.settings.assignment_rules.CREATE | Create settings assignment rules. Used by: Clone Assignment Rule; Create an Assignment Rule |
ZohoCRM.settings.assignment_rules.DELETE | Delete settings assignment rules. Used by: Delete an Assignment Rule |
ZohoCRM.settings.assignment_rules.READ | Read settings assignment rules. Used by: Assignment Rule Associations; Assignment Rules; Assignment Rules Count |
ZohoCRM.settings.assignment_rules.UPDATE | Update settings assignment rules. Used by: Clone Assignment Rule Entries; Reorder Assignment Rule entries; Update a Specific Assignment Rule |
ZohoCRM.settings.audit_logs.CREATE | Create settings audit logs. Used by: Create an audit log export job |
ZohoCRM.settings.audit_logs.READ | Read settings audit logs. Used by: Get audit log export jobs; Get the Status of the Export Audit Log Job |
ZohoCRM.settings.automation_actions.CREATE | Create settings automation actions. Used by: Create Field Update; Create an Automation Task; Webhooks |
ZohoCRM.settings.automation_actions.DELETE | Delete settings automation actions. Used by: Automation Task; Delete Field Update; Delete a webhook by ID |
ZohoCRM.settings.automation_actions.READ | Read settings automation actions. Used by: Automation Task; Get Field Update By Id; Get Field Updates |
ZohoCRM.settings.automation_actions.UPDATE | Update settings automation actions. Used by: Automation Task; Update Field Update; Update an automation task definition by ID (full replacement) |
ZohoCRM.settings.business_hours.CREATE | Create settings business hours. Used by: Add shift hours; Business Hours Configuration; Holidays |
ZohoCRM.settings.business_hours.DELETE | Delete settings business hours. Used by: Delete a shift hour; Holiday |
ZohoCRM.settings.business_hours.READ | Read settings business hours. Used by: A specific holiday; Business Hours Configuration; Get a shift hour |
ZohoCRM.settings.business_hours.UPDATE | Update settings business hours. Used by: A specific holiday; Business Hours Configuration; Multiple Holidays |
ZohoCRM.settings.cadences.CREATE | Create settings cadences. Used by: Activate Cadence; Clone a Cadence; Create cadence |
ZohoCRM.settings.cadences.DELETE | Delete settings cadences. Used by: Delete a Cadence |
ZohoCRM.settings.cadences.READ | Read settings cadences. Used by: Get Cadence analytics; Get Cadence module actions count; Get Cadence records count |
ZohoCRM.settings.cadences.UPDATE | Update settings cadences. Used by: Cadence; Update multiple Cadences (bulk form) |
ZohoCRM.settings.clientportal.ALL | Full access to settings clientportal. Used by: Delete user type; Portal User Type; Portal User Types |
ZohoCRM.settings.clientportal.CREATE | Create settings clientportal. Used by: Invite portal users; Portal; Portal User Type |
ZohoCRM.settings.clientportal.DELETE | Delete settings clientportal. Used by: Delete user type; delete portal users |
ZohoCRM.settings.clientportal.READ | Read settings clientportal. Used by: Invite portal users; List portal users; Portal User Type |
ZohoCRM.settings.clientportal.UPDATE | Update settings clientportal. Used by: Change status of portal users; Portal; Portal User Status |
ZohoCRM.settings.currencies.ALL | Full access to settings currencies |
ZohoCRM.settings.currencies.CREATE | Create settings currencies. Used by: Create currencies; Enable multi-currency |
ZohoCRM.settings.currencies.READ | Read settings currencies. Used by: List currencies; Specific Currency |
ZohoCRM.settings.currencies.UPDATE | Update settings currencies. Used by: Currency; Update base currency; Update currencies |
ZohoCRM.settings.custom_buttons.ALL | Full access to settings custom buttons |
ZohoCRM.settings.custom_links.ALL | Full access to settings custom links |
ZohoCRM.settings.custom_views.ALL | Full access to settings custom views |
ZohoCRM.settings.custom_views.CREATE | Create settings custom views. Used by: CustomView creation |
ZohoCRM.settings.custom_views.DELETE | Delete settings custom views. Used by: Delete Custom Views |
ZohoCRM.settings.custom_views.READ | Read settings custom views. Used by: Get All Custom Views; Get Custom View By Id |
ZohoCRM.settings.custom_views.UPDATE | Update settings custom views. Used by: Custom Views; CustomView update; Sort Order |
ZohoCRM.settings.data_sharing.ALL | Full access to settings data sharing. Used by: Data Sharing Settings |
ZohoCRM.settings.data_sharing.READ | Read settings data sharing. Used by: Data Sharing Settings |
ZohoCRM.settings.data_sharing.UPDATE | Update settings data sharing. Used by: Data Sharing Settings |
ZohoCRM.settings.duplicate_check_preference.CREATE | Create settings duplicate check preference. Used by: Create Duplicate Check Preference |
ZohoCRM.settings.duplicate_check_preference.DELETE | Delete settings duplicate check preference. Used by: Delete Duplicate Check Preference |
ZohoCRM.settings.duplicate_check_preference.READ | Read settings duplicate check preference. Used by: Get Duplicate Check Preference |
ZohoCRM.settings.duplicate_check_preference.UPDATE | Update settings duplicate check preference. Used by: Update Duplicate Check Preference |
ZohoCRM.settings.emails.ALL | Full access to settings emails. Used by: Send mail merge email |
ZohoCRM.settings.emails.READ | Read settings emails. Used by: Get from addresses |
ZohoCRM.settings.fields.ALL | Full access to settings fields |
ZohoCRM.settings.fields.CREATE | Create settings fields. Used by: Create custom fields in a module |
ZohoCRM.settings.fields.DELETE | Delete settings fields. Used by: Delete a custom field; Delete a picklist field option |
ZohoCRM.settings.fields.READ | Read settings fields. Used by: Get field metadata by ID; Get scheduled jobs for a field; List fields metadata |
ZohoCRM.settings.fields.UPDATE | Update settings fields. Used by: Replace Pick list values; Update a custom field; Update custom fields |
ZohoCRM.settings.fiscal_year.READ | Read settings fiscal year. Used by: Get Fiscal Year Settings |
ZohoCRM.settings.fiscal_year.UPDATE | Update settings fiscal year. Used by: Update Fiscal Year Settings |
ZohoCRM.settings.global_picklist.ALL | Full access to settings global picklist. Used by: Get Picklist Value Associations; Replace Picklist Values |
ZohoCRM.settings.global_picklist.CREATE | Create settings global picklist. Used by: Create a Global Picklist |
ZohoCRM.settings.global_picklist.DELETE | Delete settings global picklist. Used by: Delete a Global Picklist; Delete a Global Picklist by ID |
ZohoCRM.settings.global_picklist.READ | Read settings global picklist. Used by: Get All Global Picklists; Get Field Associations; Get Replaced Picklist Values |
ZohoCRM.settings.global_picklist.UPDATE | Update settings global picklist. Used by: Update a Global Picklist; Update a Global Picklist by ID |
ZohoCRM.settings.intelligence.CREATE | Create settings intelligence. Used by: Trigger organization-level enrichment for a CRM record |
ZohoCRM.settings.intelligence.READ | Read settings intelligence. Used by: Get Zia Org Enrichment; Org Enrichment Details |
ZohoCRM.settings.layouts.ALL | Full access to settings layouts |
ZohoCRM.settings.layouts.CREATE | Create settings layouts. Used by: Activate Layout |
ZohoCRM.settings.layouts.DELETE | Delete settings layouts. Used by: Deactivate Layout; Delete a custom layout |
ZohoCRM.settings.layouts.READ | Read settings layouts. Used by: Get layout by ID; Get layouts metadata |
ZohoCRM.settings.layouts.UPDATE | Update settings layouts. Used by: Update a custom layout |
ZohoCRM.settings.macros.ALL | Full access to settings macros |
ZohoCRM.settings.mailmerge.CREATE | Create settings mailmerge. Used by: Download mail merge document; Send mail merge document for signing; Send mail merge email |
ZohoCRM.settings.map_dependency.CREATE | Create settings map dependency. Used by: Create a field dependency for a layout |
ZohoCRM.settings.map_dependency.DELETE | Delete settings map dependency. Used by: Delete a field dependency |
ZohoCRM.settings.map_dependency.READ | Read settings map dependency. Used by: Get a field dependency by ID; Get field dependencies for a layout |
ZohoCRM.settings.map_dependency.UPDATE | Update settings map dependency. Used by: Update an existing field dependency |
ZohoCRM.settings.modules.ALL | Full access to settings modules. Used by: Update locking reason of a locked record |
ZohoCRM.settings.modules.CREATE | Create settings modules. Used by: Create a custom module; Lock a record |
ZohoCRM.settings.modules.DELETE | Delete settings modules. Used by: Remove lock from a locked record |
ZohoCRM.settings.modules.READ | Read settings modules. Used by: Call Preferences; Generate web-tab link for a module; Get Appointment Preferences |
ZohoCRM.settings.modules.UPDATE | Update settings modules. Used by: Call Preferences; Update Appointment Preferences; Update CRM modules |
ZohoCRM.settings.pipeline.CREATE | Create settings pipeline. Used by: Pipeline; Transfer Pipeline |
ZohoCRM.settings.pipeline.READ | Read settings pipeline. Used by: Pipelines; Specific Pipeline |
ZohoCRM.settings.pipeline.UPDATE | Update settings pipeline. Used by: Pipeline |
ZohoCRM.settings.profiles.ALL | Full access to settings profiles |
ZohoCRM.settings.profiles.CREATE | Create settings profiles. Used by: Clone a CRM profile |
ZohoCRM.settings.profiles.DELETE | Delete settings profiles. Used by: Profile |
ZohoCRM.settings.profiles.READ | Read settings profiles. Used by: Profile; Profiles |
ZohoCRM.settings.profiles.UPDATE | Update settings profiles. Used by: Profile; Specific Profile |
ZohoCRM.settings.record_locking_configurations.CREATE | Create settings record locking configurations. Used by: Create record locking configuration |
ZohoCRM.settings.record_locking_configurations.DELETE | Delete settings record locking configurations. Used by: Delete record locking configuration; Delete specific record locking configuration |
ZohoCRM.settings.record_locking_configurations.READ | Read settings record locking configurations. Used by: Get record locking configuration; Get specific record locking configuration |
ZohoCRM.settings.record_locking_configurations.UPDATE | Update settings record locking configurations. Used by: Update record locking configuration; Update specific record locking configuration |
ZohoCRM.settings.recycle_bin.DELETE | Delete settings recycle bin. Used by: Delete a recycle-bin record permanently; Delete recycle-bin records |
ZohoCRM.settings.recycle_bin.READ | Read settings recycle bin. Used by: Get a recycle-bin record; Get recycle-bin record count; Get recycle-bin records |
ZohoCRM.settings.recycle_bin.UPDATE | Update settings recycle bin. Used by: Empty the Recycle Bin; Restore a Recycle Bin record; Restore multiple Recycle Bin records |
ZohoCRM.settings.related_lists.ALL | Full access to settings related lists. Used by: Related Lists |
ZohoCRM.settings.related_lists.READ | Read settings related lists. Used by: Related Lists |
ZohoCRM.settings.roles.ALL | Full access to settings roles |
ZohoCRM.settings.roles.CREATE | Create settings roles. Used by: Create a role |
ZohoCRM.settings.roles.DELETE | Delete settings roles. Used by: Delete a role |
ZohoCRM.settings.roles.READ | Read settings roles. Used by: Get a role; Get all roles |
ZohoCRM.settings.roles.UPDATE | Update settings roles. Used by: Update a role |
ZohoCRM.settings.scoring_rules.CREATE | Create settings scoring rules. Used by: Clone a scoring rule; Scoring Rules |
ZohoCRM.settings.scoring_rules.DELETE | Delete settings scoring rules. Used by: Deactivate a scoring rule; Delete a scoring rules by ID; Scoring Rules |
ZohoCRM.settings.scoring_rules.READ | Read settings scoring rules. Used by: Get scoring rule by ID; Scoring Rules |
ZohoCRM.settings.scoring_rules.UPDATE | Update settings scoring rules. Used by: Activate a scoring rule; Scoring Rules; Update a scoring rules by ID |
ZohoCRM.settings.tab_groups.ALL | Full access to settings tab groups |
ZohoCRM.settings.tags.ALL | Full access to settings tags. Used by: Get Tag Records Count; Merge Tags |
ZohoCRM.settings.tags.CREATE | Create settings tags. Used by: Tags |
ZohoCRM.settings.tags.DELETE | Delete settings tags. Used by: Delete tag by ID; Mass delete tags |
ZohoCRM.settings.tags.READ | Read settings tags. Used by: Mass Delete Tags Status; Tags |
ZohoCRM.settings.tags.UPDATE | Update settings tags. Used by: Tags; Update tag by ID |
ZohoCRM.settings.territories.ALL | Full access to settings territories. Used by: Get scheduled territory run rule job status; Run territory assignment rules; Specific Territory User |
ZohoCRM.settings.territories.CREATE | Create settings territories. Used by: Create Territories |
ZohoCRM.settings.territories.DELETE | Delete settings territories. Used by: Delete a territory by ID; Delete territories; Remove territories from a user |
ZohoCRM.settings.territories.READ | Read settings territories. Used by: Get all territories; Get child territories by parent territory ID; Get scheduled territory run rule job status |
ZohoCRM.settings.territories.UPDATE | Update settings territories. Used by: Add territories to a user; Run territory assignment rules; Update a specific territory by its ID |
ZohoCRM.settings.unsubscribe.CREATE | Create settings unsubscribe. Used by: Create Unsubscribe Link |
ZohoCRM.settings.unsubscribe.DELETE | Delete settings unsubscribe. Used by: Delete Unsubscribe Link by ID |
ZohoCRM.settings.unsubscribe.READ | Read settings unsubscribe. Used by: Get Unsubscribe Link Associations; Get Unsubscribe Link by ID; Get Unsubscribe Links |
ZohoCRM.settings.unsubscribe.UPDATE | Update settings unsubscribe. Used by: Update Unsubscribe Link by ID; Update Unsubscribe Links |
ZohoCRM.settings.user_groups.CREATE | Create settings user groups. Used by: Create a user group |
ZohoCRM.settings.user_groups.DELETE | Delete settings user groups. Used by: Delete a user group |
ZohoCRM.settings.user_groups.READ | Read settings user groups. Used by: Get a user group; Get associated groups for a user; Get associated users count per user group |
ZohoCRM.settings.user_groups.UPDATE | Update settings user groups. Used by: Update a user group |
ZohoCRM.settings.variable_groups.CREATE | Create settings variable groups. Used by: Generate API Name |
ZohoCRM.settings.variable_groups.READ | Read settings variable groups. Used by: Get variable group by ID; Variable Groups |
ZohoCRM.settings.variable_groups.UPDATE | Update settings variable groups. Used by: Update variable group by ID; Variable Groups |
ZohoCRM.settings.variables.ALL | Full access to settings variables |
ZohoCRM.settings.variables.CREATE | Create settings variables. Used by: Create variables; Generate API Name |
ZohoCRM.settings.variables.DELETE | Delete settings variables. Used by: Delete variables; Specific variable |
ZohoCRM.settings.variables.READ | Read settings variables. Used by: Retrieve all variables; Variable Associations; specific variable |
ZohoCRM.settings.variables.UPDATE | Update settings variables. Used by: Specific variable; Update variables |
ZohoCRM.settings.wizards.READ | Read settings wizards. Used by: Get all wizard configurations; Get wizard details |
ZohoCRM.settings.workflow_rules.CREATE | Create settings workflow rules. Used by: Create a workflow rule for a module |
ZohoCRM.settings.workflow_rules.DELETE | Delete settings workflow rules. Used by: Delete One or More Workflow Rules; Delete a workflow rule by ID |
ZohoCRM.settings.workflow_rules.READ | Read settings workflow rules. Used by: Get Active and Total Workflow Rule Counts by Module; Get Workflow Rule Action Counts; Get Workflow Rule Quota and Usage Counts |
ZohoCRM.settings.workflow_rules.UPDATE | Update settings workflow rules. Used by: Update Workflow Rule Execution Order for Module; Update Workflow Rule by ID; Update workflow rules by ID in the request body |
ZohoCRM.share.accounts.CREATE | Create share accounts. Used by: Share a record |
ZohoCRM.share.accounts.DELETE | Delete share accounts. Used by: Revoke sharing on a record |
ZohoCRM.share.accounts.READ | Read share accounts. Used by: Share Records |
ZohoCRM.share.accounts.UPDATE | Update share accounts. Used by: Update share permissions |
ZohoCRM.share.bundles.CREATE | Create share bundles. Used by: Share a record |
ZohoCRM.share.bundles.DELETE | Delete share bundles. Used by: Revoke sharing on a record |
ZohoCRM.share.bundles.READ | Read share bundles. Used by: Share Records |
ZohoCRM.share.bundles.UPDATE | Update share bundles. Used by: Update share permissions |
ZohoCRM.share.calls.CREATE | Create share calls. Used by: Share a record |
ZohoCRM.share.calls.DELETE | Delete share calls. Used by: Revoke sharing on a record |
ZohoCRM.share.calls.READ | Read share calls. Used by: Share Records |
ZohoCRM.share.calls.UPDATE | Update share calls. Used by: Update share permissions |
ZohoCRM.share.campaigns.CREATE | Create share campaigns. Used by: Share a record |
ZohoCRM.share.campaigns.DELETE | Delete share campaigns. Used by: Revoke sharing on a record |
ZohoCRM.share.campaigns.READ | Read share campaigns. Used by: Share Records |
ZohoCRM.share.campaigns.UPDATE | Update share campaigns. Used by: Update share permissions |
ZohoCRM.share.cases.CREATE | Create share cases. Used by: Share a record |
ZohoCRM.share.cases.DELETE | Delete share cases. Used by: Revoke sharing on a record |
ZohoCRM.share.cases.READ | Read share cases. Used by: Share Records |
ZohoCRM.share.cases.UPDATE | Update share cases. Used by: Update share permissions |
ZohoCRM.share.contacts.CREATE | Create share contacts. Used by: Share a record |
ZohoCRM.share.contacts.DELETE | Delete share contacts. Used by: Revoke sharing on a record |
ZohoCRM.share.contacts.READ | Read share contacts. Used by: Share Records |
ZohoCRM.share.contacts.UPDATE | Update share contacts. Used by: Update share permissions |
ZohoCRM.share.custom.CREATE | Create share custom. Used by: Share a record |
ZohoCRM.share.custom.DELETE | Delete share custom. Used by: Revoke sharing on a record |
ZohoCRM.share.custom.READ | Read share custom. Used by: Share Records |
ZohoCRM.share.custom.UPDATE | Update share custom. Used by: Update share permissions |
ZohoCRM.share.deals.CREATE | Create share deals. Used by: Share a record |
ZohoCRM.share.deals.DELETE | Delete share deals. Used by: Revoke sharing on a record |
ZohoCRM.share.deals.READ | Read share deals. Used by: Share Records |
ZohoCRM.share.deals.UPDATE | Update share deals. Used by: Update share permissions |
ZohoCRM.share.events.CREATE | Create share events. Used by: Share a record |
ZohoCRM.share.events.DELETE | Delete share events. Used by: Revoke sharing on a record |
ZohoCRM.share.events.READ | Read share events. Used by: Share Records |
ZohoCRM.share.events.UPDATE | Update share events. Used by: Update share permissions |
ZohoCRM.share.invoices.CREATE | Create share invoices. Used by: Share a record |
ZohoCRM.share.invoices.DELETE | Delete share invoices. Used by: Revoke sharing on a record |
ZohoCRM.share.invoices.READ | Read share invoices. Used by: Share Records |
ZohoCRM.share.invoices.UPDATE | Update share invoices. Used by: Update share permissions |
ZohoCRM.share.leads.CREATE | Create share leads. Used by: Share a record |
ZohoCRM.share.leads.DELETE | Delete share leads. Used by: Revoke sharing on a record |
ZohoCRM.share.leads.READ | Read share leads. Used by: Share Records |
ZohoCRM.share.leads.UPDATE | Update share leads. Used by: Update share permissions |
ZohoCRM.share.pricebooks.CREATE | Create share pricebooks. Used by: Share a record |
ZohoCRM.share.pricebooks.DELETE | Delete share pricebooks. Used by: Revoke sharing on a record |
ZohoCRM.share.pricebooks.READ | Read share pricebooks. Used by: Share Records |
ZohoCRM.share.pricebooks.UPDATE | Update share pricebooks. Used by: Update share permissions |
ZohoCRM.share.products.CREATE | Create share products. Used by: Share a record |
ZohoCRM.share.products.DELETE | Delete share products. Used by: Revoke sharing on a record |
ZohoCRM.share.products.READ | Read share products. Used by: Share Records |
ZohoCRM.share.products.UPDATE | Update share products. Used by: Update share permissions |
ZohoCRM.share.purchaseorders.CREATE | Create share purchaseorders. Used by: Share a record |
ZohoCRM.share.purchaseorders.DELETE | Delete share purchaseorders. Used by: Revoke sharing on a record |
ZohoCRM.share.purchaseorders.READ | Read share purchaseorders. Used by: Share Records |
ZohoCRM.share.purchaseorders.UPDATE | Update share purchaseorders. Used by: Update share permissions |
ZohoCRM.share.quotes.CREATE | Create share quotes. Used by: Share a record |
ZohoCRM.share.quotes.DELETE | Delete share quotes. Used by: Revoke sharing on a record |
ZohoCRM.share.quotes.READ | Read share quotes. Used by: Share Records |
ZohoCRM.share.quotes.UPDATE | Update share quotes. Used by: Update share permissions |
ZohoCRM.share.salesorders.CREATE | Create share salesorders. Used by: Share a record |
ZohoCRM.share.salesorders.DELETE | Delete share salesorders. Used by: Revoke sharing on a record |
ZohoCRM.share.salesorders.READ | Read share salesorders. Used by: Share Records |
ZohoCRM.share.salesorders.UPDATE | Update share salesorders. Used by: Update share permissions |
ZohoCRM.share.solutions.CREATE | Create share solutions. Used by: Share a record |
ZohoCRM.share.solutions.DELETE | Delete share solutions. Used by: Revoke sharing on a record |
ZohoCRM.share.solutions.READ | Read share solutions. Used by: Share Records |
ZohoCRM.share.solutions.UPDATE | Update share solutions. Used by: Update share permissions |
ZohoCRM.share.tasks.CREATE | Create share tasks. Used by: Share a record |
ZohoCRM.share.tasks.DELETE | Delete share tasks. Used by: Revoke sharing on a record |
ZohoCRM.share.tasks.READ | Read share tasks. Used by: Share Records |
ZohoCRM.share.tasks.UPDATE | Update share tasks. Used by: Update share permissions |
ZohoCRM.share.vendors.CREATE | Create share vendors. Used by: Share a record |
ZohoCRM.share.vendors.DELETE | Delete share vendors. Used by: Revoke sharing on a record |
ZohoCRM.share.vendors.READ | Read share vendors. Used by: Share Records |
ZohoCRM.share.vendors.UPDATE | Update share vendors. Used by: Update share permissions |
ZohoCRM.templates.email.READ | Read templates email. Used by: Email Templates |
ZohoCRM.templates.inventory.READ | Read templates inventory. Used by: Inventory Template; Inventory templates |
ZohoCRM.users.ALL | Full access to users. Used by: Specific Territory User; Territory User; Territory Users |
ZohoCRM.users.CREATE | Create users. Used by: Create User |
ZohoCRM.users.DELETE | Delete users. Used by: Delete a user from the organization; Get transfer and delete status; Remove territories from a user |
ZohoCRM.users.READ | Read users. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get a specific user; Get territories of a user |
ZohoCRM.users.UPDATE | Update users. Used by: Add territories to a user; Transfer and delete a user; Update a single user by user ID |
ZohoCRM.zia.enrichment.CREATE | Create zia enrichment. Used by: Zia Data Enrichment Configuration |
ZohoCRM.zia.enrichment.DELETE | Delete zia enrichment. Used by: Delete Zia Enrichment Configuration for a specific module |
ZohoCRM.zia.enrichment.READ | Read zia enrichment. Used by: Data Enrichment; Get Zia Enrichment Configuration for a specific module |
ZohoCRM.zia.enrichment.UPDATE | Update zia enrichment. Used by: Update Zia Enrichment Configurations for a specific module |
ZohoSign.documents.ALL | Full access to ZohoSign documents. Used by: Send mail merge document for signing |
ZohoWriter.documentEditor.ALL | Full access to ZohoWriter documentEditor. Used by: Download mail merge document; Send mail merge document for signing; Send mail merge email |
ZohoWriter.merge.ALL | Full access to ZohoWriter merge. Used by: Download mail merge document; Send mail merge document for signing; Send mail merge email |
Policy-cataloged operations
Section titled “Policy-cataloged operations”Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.
| Operation ID | Families | Method | Provider path |
|---|---|---|---|
createBulkReadJob | read | POST | /crm/bulk/v8/read |
getBulkReadJobDetails | read | GET | /crm/bulk/v8/read/{jobId} |
downloadBulkReadResult | read | GET | /crm/bulk/v8/read/{jobId}/result |
createBulkWriteJob | write | POST | /crm/bulk/v8/write |
getBulkWriteJobDetails | read | GET | /crm/bulk/v8/write/{jobId} |
deleteAppointmentsS | delete | DELETE | /crm/v8/Appointments__s |
getAppointmentsS | read | GET | /crm/v8/Appointments__s |
createAppointmentsS | send, write | POST | /crm/v8/Appointments__s |
updateAppointmentsS | send, write | PUT | /crm/v8/Appointments__s |
deleteAppointmentById | delete | DELETE | /crm/v8/Appointments__s/{appointmentId} |
getAppointmentById | read | GET | /crm/v8/Appointments__s/{appointmentId} |
updateAppointmentById | send, write | PUT | /crm/v8/Appointments__s/{appointmentId} |
deleteContactRoles | delete | DELETE | /crm/v8/Contacts/roles |
getContactRoles | read | GET | /crm/v8/Contacts/roles |
createContactRoles | write | POST | /crm/v8/Contacts/roles |
updateContactRoles | write | PUT | /crm/v8/Contacts/roles |
deleteContactRole | delete | DELETE | /crm/v8/Contacts/roles/{role} |
getContactRole | read | GET | /crm/v8/Contacts/roles/{role} |
updateContactRole | write | PUT | /crm/v8/Contacts/roles/{role} |
unlinkEmailsFromDeal | delete | DELETE | /crm/v8/Contacts/{contactId}/Emails/actions/link_record |
linkEmailsToDeals | write | POST | /crm/v8/Contacts/{contactId}/Emails/actions/link_record |
unlinkEmailFromRecord | delete | DELETE | /crm/v8/Contacts/{contactId}/Emails/{messageId}/actions/link_record |
linkEmailToRecord | write | POST | /crm/v8/Contacts/{contactId}/Emails/{messageId}/actions/link_record |
cancelMeetings | send, write | POST | /crm/v8/Events/{event}/actions/cancel |
getMassConvertJobStatus | read | GET | /crm/v8/Leads/actions/mass_convert |
massConvert | write | POST | /crm/v8/Leads/actions/mass_convert |
getLeadConversionOptions | read | GET | /crm/v8/Leads/{leadId}/__conversion_options |
convertLead | send, write | POST | /crm/v8/Leads/{leadId}/actions/convert |
deleteNotesModule | delete | DELETE | /crm/v8/Notes |
getNotesModule | read | GET | /crm/v8/Notes |
createNotesModule | write | POST | /crm/v8/Notes |
updateNotesModule | write | PUT | /crm/v8/Notes |
deleteNoteById | delete | DELETE | /crm/v8/Notes/{id} |
getNoteById | read | GET | /crm/v8/Notes/{id} |
updateNoteById | write | PUT | /crm/v8/Notes/{id} |
deleteServicesS | delete | DELETE | /crm/v8/Services__s |
getServicesS | read | GET | /crm/v8/Services__s |
createServicesS | write | POST | /crm/v8/Services__s |
updateServicesS | write | PUT | /crm/v8/Services__s |
deleteServiceById | delete | DELETE | /crm/v8/Services__s/{id} |
getServiceById | read | GET | /crm/v8/Services__s/{id} |
updateServiceSById | write | PUT | /crm/v8/Services__s/{id} |
getAvailableApis | read | GET | /crm/v8/__apis |
createCompositeRequest | admin, delete, read, send, write | POST | /crm/v8/__composite_requests |
getFeatureDetails | read | GET | /crm/v8/__features |
getUserLicenseFeatureDetails | read | GET | /crm/v8/__features/user_licenses |
getFeatureSpecificDetails | read | GET | /crm/v8/__features/{feature} |
getZiaOrgEnrichment | read | GET | /crm/v8/__zia_org_enrichment |
submitOrgEnrichmentRequest | write | POST | /crm/v8/__zia_org_enrichment |
getOrgEnrichmentById | read | GET | /crm/v8/__zia_org_enrichment/{id} |
disableNotifications | admin, delete | DELETE | /crm/v8/actions/watch |
getNotifications | admin, read | GET | /crm/v8/actions/watch |
updateNotificationInfo | admin, write | PATCH | /crm/v8/actions/watch |
createNotifications | admin, write | POST | /crm/v8/actions/watch |
updateNotificationDetails | admin, write | PUT | /crm/v8/actions/watch |
executeCOQLQuery | read | POST | /crm/v8/coql |
getFile | read | GET | /crm/v8/files |
uploadFiles | write | POST | /crm/v8/files |
getOrganization | read | GET | /crm/v8/org |
getCurrencies | read | GET | /crm/v8/org/currencies |
createCurrencies | admin, write | POST | /crm/v8/org/currencies |
updateCurrencies | admin, write | PUT | /crm/v8/org/currencies |
enableCurrency | admin, write | POST | /crm/v8/org/currencies/actions/enable |
updateBaseCurrency | admin, write | PUT | /crm/v8/org/currencies/actions/enable |
getCurrencyById | read | GET | /crm/v8/org/currencies/{currency} |
updateCurrencyById | admin, write | PUT | /crm/v8/org/currencies/{currency} |
deleteOrgPhoto | admin, delete | DELETE | /crm/v8/org/photo |
getOrgPhoto | read | GET | /crm/v8/org/photo |
uploadOrganizationPhoto | admin, write | POST | /crm/v8/org/photo |
getAppointmentPreference | read | GET | /crm/v8/settings/appointment_preferences |
updateAppointmentPreference | admin, write | PUT | /crm/v8/settings/appointment_preferences |
getAuditLogExports | read | GET | /crm/v8/settings/audit_log_export |
createAuditLogExport | admin, read | POST | /crm/v8/settings/audit_log_export |
getAuditLogExportsById | read | GET | /crm/v8/settings/audit_log_export/{id} |
getAssignmentRules | read | GET | /crm/v8/settings/automation/assignment_rules |
postAssignmentRules | admin, write | POST | /crm/v8/settings/automation/assignment_rules |
getAssignmentRulesCount | read | GET | /crm/v8/settings/automation/assignment_rules/actions/count |
deleteAssignmentRuleById | admin, delete | DELETE | /crm/v8/settings/automation/assignment_rules/{id} |
getAssignmentRuleById | read | GET | /crm/v8/settings/automation/assignment_rules/{id} |
updateAssignmentRuleById | admin, write | PUT | /crm/v8/settings/automation/assignment_rules/{id} |
getAssignmentRuleAssociations | read | GET | /crm/v8/settings/automation/assignment_rules/{id}/actions/associations |
cloneAssignmentRule | admin, write | POST | /crm/v8/settings/automation/assignment_rules/{id}/actions/clone |
putCloneEntries | admin, write | PUT | /crm/v8/settings/automation/assignment_rules/{id}/actions/clone_entries |
putReorderEntries | admin, write | PUT | /crm/v8/settings/automation/assignment_rules/{id}/actions/reorder_entries |
getCadences | read | GET | /crm/v8/settings/automation/cadences |
postCadences | admin, write | POST | /crm/v8/settings/automation/cadences |
putUpdateCadences | admin, write | PUT | /crm/v8/settings/automation/cadences |
getCadenceModuleActionsCount | read | GET | /crm/v8/settings/automation/cadences/actions/count |
listCadencesRecordsCount | read | GET | /crm/v8/settings/automation/cadences/actions/records_count |
deleteSingleCadence | admin, delete | DELETE | /crm/v8/settings/automation/cadences/{id} |
getCadence | read | GET | /crm/v8/settings/automation/cadences/{id} |
putUpdateCadence | admin, write | PUT | /crm/v8/settings/automation/cadences/{id} |
postActivate | admin, write | POST | /crm/v8/settings/automation/cadences/{id}/actions/activate |
getCadenceAnalytics | read | GET | /crm/v8/settings/automation/cadences/{id}/actions/analytics |
postCloneCadences | admin, write | POST | /crm/v8/settings/automation/cadences/{id}/actions/clone |
postDeactivate | admin, write | POST | /crm/v8/settings/automation/cadences/{id}/actions/deactivate |
postPublish | admin, write | POST | /crm/v8/settings/automation/cadences/{id}/actions/publish |
deleteFieldUpdates | admin, delete | DELETE | /crm/v8/settings/automation/field_updates |
getFieldUpdates | read | GET | /crm/v8/settings/automation/field_updates |
createFieldUpdates | admin, write | POST | /crm/v8/settings/automation/field_updates |
deleteFieldUpdateById | admin, delete | DELETE | /crm/v8/settings/automation/field_updates/{id} |
getFieldUpdateById | read | GET | /crm/v8/settings/automation/field_updates/{id} |
updateFieldUpdateById | admin, write | PUT | /crm/v8/settings/automation/field_updates/{id} |
deleteScoringRules | admin, delete | DELETE | /crm/v8/settings/automation/scoring_rules |
getScoringRules | read | GET | /crm/v8/settings/automation/scoring_rules |
postScoringRules | admin, write | POST | /crm/v8/settings/automation/scoring_rules |
putScoringRules | admin, write | PUT | /crm/v8/settings/automation/scoring_rules |
deleteScoringRuleById | admin, delete | DELETE | /crm/v8/settings/automation/scoring_rules/{ruleId} |
getScoringRuleById | read | GET | /crm/v8/settings/automation/scoring_rules/{ruleId} |
putScoringRuleById | admin, write | PUT | /crm/v8/settings/automation/scoring_rules/{ruleId} |
deleteActivate | admin, delete | DELETE | /crm/v8/settings/automation/scoring_rules/{ruleId}/actions/activate |
putActivate | admin, write | PUT | /crm/v8/settings/automation/scoring_rules/{ruleId}/actions/activate |
postClone | admin, write | POST | /crm/v8/settings/automation/scoring_rules/{ruleId}/actions/clone |
deleteTasks | admin, delete | DELETE | /crm/v8/settings/automation/tasks |
getWorkflowTasks | read | GET | /crm/v8/settings/automation/tasks |
createWorkflowTasks | admin, write | POST | /crm/v8/settings/automation/tasks |
updateWorkflowTask | admin, write | PUT | /crm/v8/settings/automation/tasks |
deleteTaskById | admin, delete | DELETE | /crm/v8/settings/automation/tasks/{id} |
getTaskById | read | GET | /crm/v8/settings/automation/tasks/{id} |
updateWorkflowTaskById | admin, write | PUT | /crm/v8/settings/automation/tasks/{id} |
getWebhookFailures | read | GET | /crm/v8/settings/automation/webhook_failures |
deleteWebhooks | admin, delete | DELETE | /crm/v8/settings/automation/webhooks |
getWebhooks | admin, read | GET | /crm/v8/settings/automation/webhooks |
createWebhooks | admin, write | POST | /crm/v8/settings/automation/webhooks |
updateWebhooks | admin, write | PUT | /crm/v8/settings/automation/webhooks |
getWebhookAssociatedModules | read | GET | /crm/v8/settings/automation/webhooks/actions/associated_modules |
getWebhookUsageReports | read | GET | /crm/v8/settings/automation/webhooks/actions/usage_reports |
deleteWebhooksById | admin, delete | DELETE | /crm/v8/settings/automation/webhooks/{webhookId} |
getWebhookById | admin, read | GET | /crm/v8/settings/automation/webhooks/{webhookId} |
updateWebhookById | admin, write | PUT | /crm/v8/settings/automation/webhooks/{webhookId} |
deleteWorkflowRules | admin, delete | DELETE | /crm/v8/settings/automation/workflow_rules |
getWorkflowRules | read | GET | /crm/v8/settings/automation/workflow_rules |
postWorkflowRule | admin, write | POST | /crm/v8/settings/automation/workflow_rules |
updateWorkflowRule | admin, write | PUT | /crm/v8/settings/automation/workflow_rules |
getWorkflowRulesActionsCount | read | GET | /crm/v8/settings/automation/workflow_rules/actions/actions_count |
getModuleSpecificActionsCount | read | GET | /crm/v8/settings/automation/workflow_rules/actions/module_specific_count |
reorderWorkflowRules | admin, write | PUT | /crm/v8/settings/automation/workflow_rules/actions/reorder |
getWorkflowRulesCount | read | GET | /crm/v8/settings/automation/workflow_rules/actions/rules_count |
deleteWorkflowRuleById | admin, delete | DELETE | /crm/v8/settings/automation/workflow_rules/{id} |
getWorkflowRuleById | read | GET | /crm/v8/settings/automation/workflow_rules/{id} |
updateWorkflowRuleById | admin, write | PUT | /crm/v8/settings/automation/workflow_rules/{id} |
getWorkflowRuleUsage | read | GET | /crm/v8/settings/automation/workflow_rules/{workflowRuleId}/actions/usage |
getBusinessHours | read | GET | /crm/v8/settings/business_hours |
createBusinessHours | admin, write | POST | /crm/v8/settings/business_hours |
updateBusinessHours | admin, write | PUT | /crm/v8/settings/business_hours |
getShifts | read | GET | /crm/v8/settings/business_hours/shift_hours |
createShifts | admin, write | POST | /crm/v8/settings/business_hours/shift_hours |
updateShiftHours | admin, write | PUT | /crm/v8/settings/business_hours/shift_hours |
deleteSingleShiftHour | admin, delete | DELETE | /crm/v8/settings/business_hours/shift_hours/{shift} |
getSingleShiftHour | read | GET | /crm/v8/settings/business_hours/shift_hours/{shift} |
updateSingleShiftHour | admin, write | PUT | /crm/v8/settings/business_hours/shift_hours/{shift} |
getCallPreferences | read | GET | /crm/v8/settings/call_preferences |
updateCallPreferences | admin, write | PUT | /crm/v8/settings/call_preferences |
deleteCustomView | admin, delete | DELETE | /crm/v8/settings/custom_views |
getCustomViews | read | GET | /crm/v8/settings/custom_views |
createCustomView | admin, write | POST | /crm/v8/settings/custom_views |
updateCustomViewsBulk | admin, write | PUT | /crm/v8/settings/custom_views |
changeSort | admin, write | PUT | /crm/v8/settings/custom_views/actions/change_sort |
getCustomViewById | read | GET | /crm/v8/settings/custom_views/{id} |
updateCustomView | admin, write | PUT | /crm/v8/settings/custom_views/{id} |
changeSortById | admin, write | PUT | /crm/v8/settings/custom_views/{id}/actions/change_sort |
getDataSharing | read | GET | /crm/v8/settings/data_sharing |
updateDataSharing | admin, write | PUT | /crm/v8/settings/data_sharing |
deleteDuplicateCheckPreference | admin, delete | DELETE | /crm/v8/settings/duplicate_check_preference |
getDuplicateCheckPreference | read | GET | /crm/v8/settings/duplicate_check_preference |
createDuplicateCheckPreference | admin, write | POST | /crm/v8/settings/duplicate_check_preference |
updateDuplicateCheckPreference | admin, write | PUT | /crm/v8/settings/duplicate_check_preference |
getEmailTemplates | read | GET | /crm/v8/settings/email_templates |
getFromAddresses | read | GET | /crm/v8/settings/emails/actions/from_addresses |
getFields | read | GET | /crm/v8/settings/fields |
updateField | admin, write | PATCH | /crm/v8/settings/fields |
createFields | admin, write | POST | /crm/v8/settings/fields |
deleteCustomField | admin, delete | DELETE | /crm/v8/settings/fields/{fieldId} |
getFieldsWithID | read | GET | /crm/v8/settings/fields/{fieldId} |
putFieldsWithId | admin, write | PATCH | /crm/v8/settings/fields/{fieldId} |
postReplacePickListValues | admin, write | POST | /crm/v8/settings/fields/{fieldId}/actions/replace_pick_list_values |
getScheduledJobs | read | GET | /crm/v8/settings/fields/{fieldId}/actions/scheduled_jobs |
getPickListValues | read | GET | /crm/v8/settings/fields/{fieldId}/pick_list_values |
deletePickListValuesByPickListValueid | admin, delete | DELETE | /crm/v8/settings/fields/{fieldId}/pick_list_values/{pickListValueId} |
getPickListValuesByPickListValueid | read | GET | /crm/v8/settings/fields/{fieldId}/pick_list_values/{pickListValueId} |
getFiscalYear | read | GET | /crm/v8/settings/fiscal_year |
updateFiscalYear | admin, write | PUT | /crm/v8/settings/fiscal_year |
deleteGlobalPicklists | admin, delete | DELETE | /crm/v8/settings/global_picklists |
getBulkGlobalPicklists | read | GET | /crm/v8/settings/global_picklists |
updateGlobalPicklist | admin, write | PATCH | /crm/v8/settings/global_picklists |
createGlobalPicklist | admin, write | POST | /crm/v8/settings/global_picklists |
deleteGlobalPicklist | admin, delete | DELETE | /crm/v8/settings/global_picklists/{id} |
getSingleGlobalPicklists | read | GET | /crm/v8/settings/global_picklists/{id} |
updateGlobalPicklistById | admin, write | PATCH | /crm/v8/settings/global_picklists/{id} |
getGlobalPickListFieldAssociations | read | GET | /crm/v8/settings/global_picklists/{id}/actions/associations |
getPickListValuesAssociations | read | GET | /crm/v8/settings/global_picklists/{id}/actions/pick_list_values_associations |
replacePicklistValues | admin, write | POST | /crm/v8/settings/global_picklists/{id}/actions/replace_picklist_values |
getReplacedValues | read | GET | /crm/v8/settings/global_picklists/{id}/actions/replaced_values |
getHolidays | read | GET | /crm/v8/settings/holidays |
createHolidays | admin, write | POST | /crm/v8/settings/holidays |
updateHolidays | admin, write | PUT | /crm/v8/settings/holidays |
deleteHoliday | admin, delete | DELETE | /crm/v8/settings/holidays/{holidayId} |
getHoliday | read | GET | /crm/v8/settings/holidays/{holidayId} |
updateHoliday | admin, write | PUT | /crm/v8/settings/holidays/{holidayId} |
getInventoryTemplates | read | GET | /crm/v8/settings/inventory_templates |
getInventoryTemplateById | read | GET | /crm/v8/settings/inventory_templates/{templateId} |
getLayouts | read | GET | /crm/v8/settings/layouts |
deleteLayout | admin, delete | DELETE | /crm/v8/settings/layouts/{id} |
getLayoutById | read | GET | /crm/v8/settings/layouts/{id} |
updateLayout | admin, write | PATCH | /crm/v8/settings/layouts/{id} |
layoutDeactivate | admin, delete | DELETE | /crm/v8/settings/layouts/{id}/actions/activate |
activateLayout | admin, write | POST | /crm/v8/settings/layouts/{id}/actions/activate |
getMapDependency | read | GET | /crm/v8/settings/layouts/{layoutId}/map_dependency |
createMapDependency | admin, write | POST | /crm/v8/settings/layouts/{layoutId}/map_dependency |
deleteMapDependency | admin, delete | DELETE | /crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId} |
getMapDependencyById | read | GET | /crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId} |
updateMapDependency | admin, write | PUT | /crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId} |
getGenerateLink | read | GET | /crm/v8/settings/module/{moduleid}/actions/generate_link |
getModules | read | GET | /crm/v8/settings/modules |
createModules | admin, write | POST | /crm/v8/settings/modules |
updateModules | admin, write | PUT | /crm/v8/settings/modules |
getModuleByApiName | read | GET | /crm/v8/settings/modules/{moduleIdentifier} |
updateModuleByApiName | admin, write | PUT | /crm/v8/settings/modules/{moduleIdentifier} |
getPipelines | read | GET | /crm/v8/settings/pipeline |
updatePipelines | admin, write | PATCH | /crm/v8/settings/pipeline |
createPipeline | admin, write | POST | /crm/v8/settings/pipeline |
replacePipelines | admin, write | PUT | /crm/v8/settings/pipeline |
transferAndDeletePipelines | admin, delete | POST | /crm/v8/settings/pipeline/actions/transfer |
getPipeline | read | GET | /crm/v8/settings/pipeline/{pipelineIdentifier} |
updatePipelineById | admin, write | PATCH | /crm/v8/settings/pipeline/{pipelineIdentifier} |
replacePipelineById | admin, write | PUT | /crm/v8/settings/pipeline/{pipelineIdentifier} |
getPortals | read | GET | /crm/v8/settings/portals |
createPortal | admin, write | POST | /crm/v8/settings/portals |
getPortal | read | GET | /crm/v8/settings/portals/{portal} |
updatePortal | admin, write | PUT | /crm/v8/settings/portals/{portal} |
getPortalUserTypes | read | GET | /crm/v8/settings/portals/{portal}/user_type |
createPortalUserType | admin, write | POST | /crm/v8/settings/portals/{portal}/user_type |
deletePortalUserType | admin, delete | DELETE | /crm/v8/settings/portals/{portal}/user_type/{userTypeId} |
getPortalUserType | read | GET | /crm/v8/settings/portals/{portal}/user_type/{userTypeId} |
updatePortalUserType | admin, write | PUT | /crm/v8/settings/portals/{portal}/user_type/{userTypeId} |
deletePortalUsers | admin, delete | DELETE | /crm/v8/settings/portals/{portal}/user_type/{userType}/users |
getPortalUsers | read | GET | /crm/v8/settings/portals/{portal}/user_type/{userType}/users |
transferPortalUsers | admin, write | POST | /crm/v8/settings/portals/{portal}/user_type/{userType}/users/action/transfer |
changePortalUsersStatusBulk | admin, write | PUT | /crm/v8/settings/portals/{portal}/user_type/{userType}/users/actions/change_status |
changePortalUsersStatus | admin, write | PUT | /crm/v8/settings/portals/{portal}/user_type/{userType}/users/{recordId}/actions/change_status |
getProfiles | read | GET | /crm/v8/settings/profiles |
deleteProfile | admin, delete | DELETE | /crm/v8/settings/profiles/{id} |
getProfile | read | GET | /crm/v8/settings/profiles/{id} |
patchProfile | admin, write | PATCH | /crm/v8/settings/profiles/{id} |
updateProfile | admin, write | PUT | /crm/v8/settings/profiles/{id} |
cloneProfile | admin, write | POST | /crm/v8/settings/profiles/{id}/actions/clone |
deleteRecordLockingConfiguration | admin, delete | DELETE | /crm/v8/settings/record_locking_configurations |
getRecordLockingConfiguration | read | GET | /crm/v8/settings/record_locking_configurations |
createRecordLockingConfiguration | admin, write | POST | /crm/v8/settings/record_locking_configurations |
updateRecordLockingConfiguration | admin, write | PUT | /crm/v8/settings/record_locking_configurations |
deleteRecordLockingConfigurationPassingIdInURL | admin, delete | DELETE | /crm/v8/settings/record_locking_configurations/{id} |
getRecordLockingConfigurationPassingIdInURL | read | GET | /crm/v8/settings/record_locking_configurations/{id} |
updateRecordLockingConfigurationPassingIdInURL | admin, write | PUT | /crm/v8/settings/record_locking_configurations/{id} |
deleteRecycleBinRecords | admin, delete | DELETE | /crm/v8/settings/recycle_bin |
getRecycleBinRecords | read | GET | /crm/v8/settings/recycle_bin |
getRecycleBinCounts | read | GET | /crm/v8/settings/recycle_bin/actions/count |
emptyRecycleBin | admin, delete | POST | /crm/v8/settings/recycle_bin/actions/empty |
restoreRecycleBinRecords | admin, write | POST | /crm/v8/settings/recycle_bin/actions/restore |
deleteRecycleBinRecord | admin, delete | DELETE | /crm/v8/settings/recycle_bin/{recordId} |
getRecycleBinRecord | read | GET | /crm/v8/settings/recycle_bin/{recordId} |
restoreRecycleBinRecord | admin, write | POST | /crm/v8/settings/recycle_bin/{recordId}/actions/restore |
getRelatedLists | read | GET | /crm/v8/settings/related_lists |
getRoles | read | GET | /crm/v8/settings/roles |
createRoles | admin, write | POST | /crm/v8/settings/roles |
updateRoles | admin, write | PUT | /crm/v8/settings/roles |
deleteRole | admin, delete | DELETE | /crm/v8/settings/roles/{role} |
getRole | read | GET | /crm/v8/settings/roles/{role} |
updateRole | admin, write | PUT | /crm/v8/settings/roles/{role} |
getServicePreference | read | GET | /crm/v8/settings/service_preferences |
updateServicePreference | admin, write | PUT | /crm/v8/settings/service_preferences |
getTags | read | GET | /crm/v8/settings/tags |
createTags | admin, write | POST | /crm/v8/settings/tags |
updateTags | admin, write | PUT | /crm/v8/settings/tags |
getMassDeleteTagsStatus | read | GET | /crm/v8/settings/tags/actions/mass_delete |
massDeleteTags | admin, delete | POST | /crm/v8/settings/tags/actions/mass_delete |
deleteTags | admin, delete | DELETE | /crm/v8/settings/tags/{id} |
updateTagById | admin, write | PUT | /crm/v8/settings/tags/{id} |
mergeTags | admin, write | POST | /crm/v8/settings/tags/{id}/actions/merge |
getTagRecordsCount | read | GET | /crm/v8/settings/tags/{id}/actions/records_count |
deleteTerritories | admin, delete | DELETE | /crm/v8/settings/territories |
getTerritories | read | GET | /crm/v8/settings/territories |
createTerritories | admin, write | POST | /crm/v8/settings/territories |
updateTerritories | admin, write | PUT | /crm/v8/settings/territories |
getTerritoryAssociatedUsersCount | read | GET | /crm/v8/settings/territories/actions/associated_users_count |
runTerritoryRules | admin, write | POST | /crm/v8/settings/territories/actions/run_rules |
getTerritoryScheduledRunRuleJobs | read | GET | /crm/v8/settings/territories/actions/scheduled_run_rule_jobs |
transferAndDeleteTerritories | admin, delete | POST | /crm/v8/settings/territories/actions/transfer_and_delete |
deleteTerritoryById | admin, delete | DELETE | /crm/v8/settings/territories/{id} |
getTerritoryById | read | GET | /crm/v8/settings/territories/{id} |
updateTerritoryById | admin, write | PUT | /crm/v8/settings/territories/{id} |
getChildTerritoriesByParentId | read | GET | /crm/v8/settings/territories/{id}/__child_territories |
transferAndDeleteTerritoryById | admin, delete | POST | /crm/v8/settings/territories/{id}/actions/transfer_and_delete |
deassociateUsersFromTerritories | admin, delete | DELETE | /crm/v8/settings/territories/{territory}/users |
getTerritoryUsers | read | GET | /crm/v8/settings/territories/{territory}/users |
associateUsersToTerritory | admin, write | PUT | /crm/v8/settings/territories/{territory}/users |
deassociateUserFromSpecificTerritory | admin, delete | DELETE | /crm/v8/settings/territories/{territory}/users/{user} |
getUserDetailsFromTerritory | read | GET | /crm/v8/settings/territories/{territory}/users/{user} |
associateUserToSpecificTerritory | admin, write | PUT | /crm/v8/settings/territories/{territory}/users/{user} |
getAssociations | read | GET | /crm/v8/settings/unsubscribe_link/actions/associations |
getUnsubscribeLinks | read | GET | /crm/v8/settings/unsubscribe_links |
postUnsubscribeLinks | admin, write | POST | /crm/v8/settings/unsubscribe_links |
putUnsubscribeLinks | admin, write | PUT | /crm/v8/settings/unsubscribe_links |
deleteUnsubscribeLinksById | admin, delete | DELETE | /crm/v8/settings/unsubscribe_links/{id} |
getUnsubscribeLinkById | read | GET | /crm/v8/settings/unsubscribe_links/{id} |
putUnsubscribeLinksById | admin, write | PUT | /crm/v8/settings/unsubscribe_links/{id} |
getUserGroups | read | GET | /crm/v8/settings/user_groups |
createGroup | admin, write | POST | /crm/v8/settings/user_groups |
getUserGroupAssociatedUsersCount | read | GET | /crm/v8/settings/user_groups/actions/associated_users_count |
deleteGroup | admin, delete | DELETE | /crm/v8/settings/user_groups/{group} |
getGroup | read | GET | /crm/v8/settings/user_groups/{group} |
updateGroup | admin, write | PUT | /crm/v8/settings/user_groups/{group} |
getUserGroupAssociations | read | GET | /crm/v8/settings/user_groups/{group}/actions/associations |
getUserGroupSourcesCount | read | GET | /crm/v8/settings/user_groups/{group}/actions/sources_count |
getUserGroupSources | read | GET | /crm/v8/settings/user_groups/{group}/sources |
getVariableGroups | read | GET | /crm/v8/settings/variable_groups |
updateVariableGroups | admin, write | PUT | /crm/v8/settings/variable_groups |
generateAPIName | admin, write | POST | /crm/v8/settings/variable_groups/actions/generate_api_name |
getVariableGroupById | read | GET | /crm/v8/settings/variable_groups/{id} |
updateVariableGroupById | admin, write | PUT | /crm/v8/settings/variable_groups/{id} |
deleteVariables | admin, delete | DELETE | /crm/v8/settings/variables |
getVariables | admin, read | GET | /crm/v8/settings/variables |
createVariables | admin, write | POST | /crm/v8/settings/variables |
updateVariables | admin, write | PUT | /crm/v8/settings/variables |
postGenerateApiName | admin, write | POST | /crm/v8/settings/variables/actions/generate_api_name |
deleteVariablesById | admin, delete | DELETE | /crm/v8/settings/variables/{id} |
getVariableById | admin, read | GET | /crm/v8/settings/variables/{id} |
updateVariableById | admin, write | PUT | /crm/v8/settings/variables/{id} |
getVariableAssociations | read | GET | /crm/v8/settings/variables/{id}/actions/associations |
getAllWizards | read | GET | /crm/v8/settings/wizards |
getWizardDetails | read | GET | /crm/v8/settings/wizards/{id} |
getZiaEnrichmentConfiguration | read | GET | /crm/v8/settings/zia/data_enrichment |
createZiaEnrichmentConfigurations | admin, write | POST | /crm/v8/settings/zia/data_enrichment |
deleteZiaEnrichmentConfiguration | admin, delete | DELETE | /crm/v8/settings/zia/data_enrichment/{id} |
getSpecificZiaEnrichmentConfiguration | read | GET | /crm/v8/settings/zia/data_enrichment/{id} |
updateZiaEnrichmentConfigurations | admin, write | PUT | /crm/v8/settings/zia/data_enrichment/{id} |
getUsers | read | GET | /crm/v8/users |
createUser | admin, send, write | POST | /crm/v8/users |
updateUser | admin, write | PUT | /crm/v8/users |
getTransferAPIStatus | read | GET | /crm/v8/users/actions/transfer |
getTransferStatus | read | GET | /crm/v8/users/actions/transfer_and_delete |
userTransferWithoutId | admin, delete | POST | /crm/v8/users/actions/transfer_and_delete |
userTransferAPI | admin, write | POST | /crm/v8/users/{userId}/actions/transfer |
userTransfer | admin, delete | POST | /crm/v8/users/{userId}/actions/transfer_and_delete |
getValidateBeforeTransferStatus | read | GET | /crm/v8/users/{userId}/actions/validate_before_transfer |
deleteUser | admin, delete | DELETE | /crm/v8/users/{user} |
getSingleUser | read | GET | /crm/v8/users/{user} |
updateSingleUser | admin, write | PUT | /crm/v8/users/{user} |
getAssociatedGroupsForUser | read | GET | /crm/v8/users/{user}/actions/associated_groups |
removeTerritoriesfromUser | admin, delete | DELETE | /crm/v8/users/{user}/territories |
getTerritoriesOfUser | read | GET | /crm/v8/users/{user}/territories |
associateTerritoriesToUser | admin, write | PUT | /crm/v8/users/{user}/territories |
removeSpecificTerritoriesfromUser | admin, delete | DELETE | /crm/v8/users/{user}/territories/{territory} |
getSpecificTerritoryOfUser | read | GET | /crm/v8/users/{user}/territories/{territory} |
getWorkflowConfigurations | read | GET | /crm/v8/workflow_configurations |
getRecordCount | read | GET | /crm/v8/{moduleApiName}/actions/count |
fetchFullDataForMultipleRecords | read | GET | /crm/v8/{moduleApiName}/actions/fetch_full_data |
shareBulkEmails | write | POST | /crm/v8/{moduleApiName}/actions/share_emails |
unshareBulkEmails | write | POST | /crm/v8/{moduleApiName}/actions/unshare_emails |
getEmailSharingDetail | read | GET | /crm/v8/{moduleApiName}/{id}/__emails_sharing_details |
convertInventory | write | POST | /crm/v8/{moduleApiName}/{id}/actions/convert |
fetchFullDataForSingleRecord | read | GET | /crm/v8/{moduleApiName}/{id}/actions/fetch_full_data |
shareEmails | write | POST | /crm/v8/{moduleApiName}/{id}/actions/share_emails |
unshareEmails | write | POST | /crm/v8/{moduleApiName}/{id}/actions/unshare_emails |
getAttachments | read | GET | /crm/v8/{moduleApiName}/{recordId}/Attachments |
uploadAttachment | write | POST | /crm/v8/{moduleApiName}/{recordId}/Attachments |
deleteAttachment | delete | DELETE | /crm/v8/{moduleApiName}/{recordId}/Attachments/{id} |
getAttachmentById | read | GET | /crm/v8/{moduleApiName}/{recordId}/Attachments/{id} |
postDownloadMailMerge | read | POST | /crm/v8/{moduleApiName}/{recordId}/actions/download_mail_merge |
getRelatedRecordsCount | read | POST | /crm/v8/{moduleApiName}/{recordId}/actions/get_related_records_count |
postSendMailMerge | send, write | POST | /crm/v8/{moduleApiName}/{recordId}/actions/send_mail_merge |
deleteShareRecords | admin, delete | DELETE | /crm/v8/{moduleApiName}/{recordId}/actions/share |
getShareRecords | read | GET | /crm/v8/{moduleApiName}/{recordId}/actions/share |
createShareRecords | admin, send, write | POST | /crm/v8/{moduleApiName}/{recordId}/actions/share |
updateShareRecords | admin, send, write | PUT | /crm/v8/{moduleApiName}/{recordId}/actions/share |
postSignMailMerge | send, write | POST | /crm/v8/{moduleApiName}/{recordId}/actions/sign_mail_merge |
sendMail | send, write | POST | /crm/v8/{moduleName}/{id}/actions/send_mail |
getRecordLockingInformationOfTheRecord | read | GET | /crm/v8/{moduleName}/{recordId}/Locking_Information__s |
lockRecord | write | POST | /crm/v8/{moduleName}/{recordId}/Locking_Information__s |
removeLockFromLockedRecord | delete | DELETE | /crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId} |
getRecordLockingInformationById | read | GET | /crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId} |
updateReasonofLockedRecord | write | PUT | /crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId} |
deleteRecords | delete | DELETE | /crm/v8/{module} |
getRecords | read | GET | /crm/v8/{module} |
createRecords | send, write | POST | /crm/v8/{module} |
updateRecords | send, write | PUT | /crm/v8/{module} |
postAddTags | write | POST | /crm/v8/{module}/actions/add_tags |
assignTerritoriesToRecords | write | POST | /crm/v8/{module}/actions/assign_territories |
changeOwnerBulk | send, write | POST | /crm/v8/{module}/actions/change_owner |
postEnrolInCadences | send, write | POST | /crm/v8/{module}/actions/enrol_in_cadences |
getMassChangeOwnerStatus | read | GET | /crm/v8/{module}/actions/mass_change_owner |
massChangeOwner | write | POST | /crm/v8/{module}/actions/mass_change_owner |
getMassDeleteJobStatus | read | GET | /crm/v8/{module}/actions/mass_delete |
massDelete | delete | POST | /crm/v8/{module}/actions/mass_delete |
getMassUpdateStatus | read | GET | /crm/v8/{module}/actions/mass_update |
massUpdateRecords | write | POST | /crm/v8/{module}/actions/mass_update |
getScheduledInviteUsersInfo | read | GET | /crm/v8/{module}/actions/portal_invite |
inviteUsers | admin, send, write | POST | /crm/v8/{module}/actions/portal_invite |
postRemoveTags | write | POST | /crm/v8/{module}/actions/remove_tags |
removeTerritoriesFromRecords | write | POST | /crm/v8/{module}/actions/remove_territories |
unblockEmailByModule | write | POST | /crm/v8/{module}/actions/unblock_email |
postUnenrolFromCadences | write | POST | /crm/v8/{module}/actions/unenrol_from_cadences |
bulkSearchRecords | read | POST | /crm/v8/{module}/bulk/search |
getDeletedRecords | read | GET | /crm/v8/{module}/deleted |
searchRecords | read | GET | /crm/v8/{module}/search |
upsertRecords | send, write | POST | /crm/v8/{module}/upsert |
deleteContactRoleRelations | delete | DELETE | /crm/v8/{module}/{dealId}/Contact_Roles |
getAssociatedContactRoles | read | GET | /crm/v8/{module}/{dealId}/Contact_Roles |
upsertContactRoleRelations | write | PUT | /crm/v8/{module}/{dealId}/Contact_Roles |
deleteContactRoleRelation | delete | DELETE | /crm/v8/{module}/{dealId}/Contact_Roles/{contactId} |
getDealContactRoleForContact | read | GET | /crm/v8/{module}/{dealId}/Contact_Roles/{contactId} |
associateContactRoleToDeal | write | PUT | /crm/v8/{module}/{dealId}/Contact_Roles/{contactId} |
postAddTagsWithId | write | POST | /crm/v8/{module}/{id}/actions/add_tags |
postRemoveTagsWithId | write | POST | /crm/v8/{module}/{id}/actions/remove_tags |
unblockEmailById | write | POST | /crm/v8/{module}/{id}/actions/unblock_email |
getMergeJobStatus | read | GET | /crm/v8/{module}/{masterRecordId}/actions/merge |
mergeRecords | delete, write | POST | /crm/v8/{module}/{masterRecordId}/actions/merge |
deleteRecord | delete | DELETE | /crm/v8/{module}/{recordId} |
getRecord | read | GET | /crm/v8/{module}/{recordId} |
updateRecord | send, write | PUT | /crm/v8/{module}/{recordId} |
downloadEmailAttachments | read | GET | /crm/v8/{module}/{recordId}/Emails/actions/download_attachments |
getDownloadInlineImages | read | GET | /crm/v8/{module}/{recordId}/Emails/actions/download_inline_images |
getTimelines | read | GET | /crm/v8/{module}/{recordId}/__timeline |
associateEmail | write | POST | /crm/v8/{module}/{recordId}/actions/associate_email |
cloneRecord | write | POST | /crm/v8/{module}/{recordId}/actions/clone |
singleInviteUser | admin, send, write | POST | /crm/v8/{module}/{recordId}/actions/portal_invite |
getEmailDrafts | read | GET | /crm/v8/{module}/{record}/__email_drafts |
createEmailDrafts | write | POST | /crm/v8/{module}/{record}/__email_drafts |
updateEmailDraftsForRecord | write | PUT | /crm/v8/{module}/{record}/__email_drafts |
deleteEmailDrafts | delete | DELETE | /crm/v8/{module}/{record}/__email_drafts/{draft} |
getEmailDraft | read | GET | /crm/v8/{module}/{record}/__email_drafts/{draft} |
updateEmailDrafts | write | PUT | /crm/v8/{module}/{record}/__email_drafts/{draft} |
assignTerritoriesToRecord | write | POST | /crm/v8/{module}/{record}/actions/assign_territories |
changeSingleRecordOwner | send, write | POST | /crm/v8/{module}/{record}/actions/change_owner |
removeTerritoriesFromRecord | write | POST | /crm/v8/{module}/{record}/actions/remove_territories |
deleteRecordPhoto | delete | DELETE | /crm/v8/{module}/{record}/photo |
getRecordPhoto | read | GET | /crm/v8/{module}/{record}/photo |
uploadRecordPhoto | write | POST | /crm/v8/{module}/{record}/photo |
getDeletedRelatedRecord | read | GET | /crm/v8/{parentRecordModule}/deleted/{parentRecord}/{relatedList} |
deleteBulkNotes | delete | DELETE | /crm/v8/{parentRecordModule}/{parentRecordId}/Notes |
getNotes | read | GET | /crm/v8/{parentRecordModule}/{parentRecordId}/Notes |
createNotes | write | POST | /crm/v8/{parentRecordModule}/{parentRecordId}/Notes |
updateBulkNotes | write | PUT | /crm/v8/{parentRecordModule}/{parentRecordId}/Notes |
deleteRelatedNoteById | delete | DELETE | /crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId} |
getNotesById | read | GET | /crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId} |
updateRelatedNoteById | write | PUT | /crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId} |
delinkRelatedRecords | delete | DELETE | /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList} |
getRelatedRecords | read | GET | /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList} |
updateRelatedRecords | write | PUT | /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList} |
delinkSpecificRelatedRecord | delete | DELETE | /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record} |
getRelatedRecord | read | GET | /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record} |
updateSpecificRelatedRecord | write | PUT | /crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record} |