Skip to content

Integrations

Zoho CRM

Set up Zoho CRM OAuth for records, settings, and email in any Zoho data center

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.

PropertyValue
Provider IDzoho
CategoryCRM
PKCESupported
Token refreshAutomatic
Redirect URIShown in Developer Portal

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.

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.

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.

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"},
)

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.

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.

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:

FamilyZoho CRM operations it covers
readEvery GET, plus the read-only POST calls: COQL queries, bulk search, related-record counts, mail merge downloads, bulk read jobs, and audit log exports
writeEvery create and update
deleteEvery 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)
sendCalls 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)
adminEvery 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 send family, so no email or invitation a call sends reaches a person without approval.
  • Deny the admin family on agent grants.
  • Restrict a grant to GET on /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.

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.

ScopeDescription
openidAlways requested. The user’s unique Zoho identifier, the connection’s account
emailAlways requested. The user’s email address and whether Zoho verified it
profileRequested by default. The user’s profile information, such as their name
ZohoCRM.apis.READRead apis. Used by: List available REST APIs
ZohoCRM.bulk.ALLFull access to bulk
ZohoCRM.bulk.CREATECreate bulk. Used by: Create a bulk write job; Get bulk write job details
ZohoCRM.bulk.READRead bulk. Used by: Create a bulk read job; Download bulk read result; Get bulk read job details
ZohoCRM.change_owner.CREATECreate change owner. Used by: Change Owner; Submit mass change owner job; Transfer a user
ZohoCRM.change_owner.READRead change owner. Used by: Get mass change owner job status; Get user transfer status; Validate user before transfer
ZohoCRM.composite_requests.CUSTOMUse composite requests. Used by: Process multiple API requests in a single call
ZohoCRM.coql.READRead coql. Used by: Retrieve records using a COQL query
ZohoCRM.features.READRead features. Used by: Features; Specific Feature; User Licenses Feature
ZohoCRM.files.CREATECreate files. Used by: Upload files to ZFS
ZohoCRM.files.READRead files. Used by: Retrieve a file from ZFS
ZohoCRM.mass_convert.leads.CREATECreate mass convert leads. Used by: Submit mass convert job for leads
ZohoCRM.mass_convert.leads.READRead mass convert leads. Used by: Get mass convert job status
ZohoCRM.mass_delete.DELETEDelete mass delete. Used by: Delete records in bulk by record IDs or Custom View
ZohoCRM.mass_delete.READRead mass delete. Used by: Retrieve mass delete job status
ZohoCRM.mass_update.leads.READRead mass update leads. Used by: Get mass update job status
ZohoCRM.mass_update.leads.UPDATEUpdate mass update leads. Used by: Mass update records
ZohoCRM.mass_update.READRead mass update. Used by: Get mass update job status
ZohoCRM.mass_update.UPDATEUpdate mass update. Used by: Mass update records
ZohoCRM.modules.accounts.ALLFull access to accounts records
ZohoCRM.modules.accounts.CREATECreate accounts records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Merge Records
ZohoCRM.modules.accounts.DELETEDelete accounts records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.accounts.READRead accounts records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Merge Job Status; Get Timelines
ZohoCRM.modules.accounts.UPDATEUpdate 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.ALLFull access to activities records
ZohoCRM.modules.activities.CREATECreate activities records. Used by: Share Record Emails
ZohoCRM.modules.activities.DELETEDelete activities records. Used by: Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.activities.READRead activities records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Search Records by Criteria, Word, Email, or Phone
ZohoCRM.modules.activities.UPDATEUpdate activities records
ZohoCRM.modules.ALLFull 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.ALLFull access to appointments records
ZohoCRM.modules.appointments.CREATECreate appointments records. Used by: Create Appointment records
ZohoCRM.modules.appointments.DELETEDelete appointments records. Used by: Delete an Appointment by ID; Delete one or more appointment records
ZohoCRM.modules.appointments.READRead appointments records. Used by: Get Appointment Records; Get an Appointment Record by ID
ZohoCRM.modules.appointments.UPDATEUpdate appointments records. Used by: Update an Appointment Record by ID; Update appointment records
ZohoCRM.modules.appointments_rescheduled_history.ALLFull access to appointments rescheduled history records
ZohoCRM.modules.appointments_rescheduled_history.CREATECreate appointments rescheduled history records
ZohoCRM.modules.appointments_rescheduled_history.DELETEDelete appointments rescheduled history records
ZohoCRM.modules.appointments_rescheduled_history.READRead appointments rescheduled history records
ZohoCRM.modules.appointments_rescheduled_history.UPDATEUpdate appointments rescheduled history records
ZohoCRM.modules.approvals.ALLFull access to approvals records
ZohoCRM.modules.approvals.CREATECreate approvals records
ZohoCRM.modules.approvals.DELETEDelete approvals records
ZohoCRM.modules.approvals.READRead approvals records
ZohoCRM.modules.approvals.UPDATEUpdate approvals records
ZohoCRM.modules.attachments.ALLFull access to attachments records. Used by: Delete Link Attachment; Retrieve All Attachments; Upload an Attachment
ZohoCRM.modules.attachments.CREATECreate attachments records. Used by: Share Record Emails; Upload an Attachment
ZohoCRM.modules.attachments.DELETEDelete attachments records. Used by: Delete Link Attachment; Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.attachments.READRead attachments records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Download a specific attachment file; Retrieve All Attachments
ZohoCRM.modules.calls.ALLFull access to calls records
ZohoCRM.modules.calls.CREATECreate calls records. Used by: Share Record Emails
ZohoCRM.modules.calls.DELETEDelete calls records. Used by: Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.calls.READRead calls records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count
ZohoCRM.modules.calls.UPDATEUpdate calls records
ZohoCRM.modules.campaigns.ALLFull access to campaigns records
ZohoCRM.modules.campaigns.CREATECreate campaigns records. Used by: Share Record Emails
ZohoCRM.modules.campaigns.DELETEDelete campaigns records. Used by: Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.campaigns.READRead campaigns records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count
ZohoCRM.modules.campaigns.UPDATEUpdate campaigns records
ZohoCRM.modules.cases.ALLFull access to cases records
ZohoCRM.modules.cases.CREATECreate cases records. Used by: Create Email Drafts for a Record; Share Record Emails
ZohoCRM.modules.cases.DELETEDelete cases records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.cases.READRead cases records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Get an Email Draft
ZohoCRM.modules.cases.UPDATEUpdate 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.ALLFull access to contacts records. Used by: Download an inline image from an email
ZohoCRM.modules.contacts.CREATECreate contacts records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Link Deal Email
ZohoCRM.modules.contacts.DELETEDelete contacts records. Used by: Deal Contact Roles; Delete Contact Roles; Delete a Contact Role
ZohoCRM.modules.contacts.READRead contacts records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Deal Contact Roles; Get Merge Job Status
ZohoCRM.modules.contacts.UPDATEUpdate contacts records. Used by: Deal Contact Roles; Unblock email for a single record; Unblock emails for multiple records in a module
ZohoCRM.modules.contacts.WRITEWrite contacts records. Used by: Create Contact Roles
ZohoCRM.modules.CREATECreate 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.ALLFull access to custom records
ZohoCRM.modules.custom.CREATECreate custom records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Merge Records
ZohoCRM.modules.custom.DELETEDelete custom records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.custom.READRead custom records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Merge Job Status; Get Timelines
ZohoCRM.modules.custom.UPDATEUpdate 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.ALLFull access to dashboards records
ZohoCRM.modules.dashboards.CREATECreate dashboards records
ZohoCRM.modules.dashboards.DELETEDelete dashboards records
ZohoCRM.modules.dashboards.READRead dashboards records
ZohoCRM.modules.dashboards.UPDATEUpdate dashboards records
ZohoCRM.modules.deals.ALLFull access to deals records. Used by: Download an inline image from an email
ZohoCRM.modules.deals.CREATECreate deals records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Link Deal Email
ZohoCRM.modules.deals.DELETEDelete deals records. Used by: Deal Contact Roles; Delete an Email Draft; Unshare Record Emails
ZohoCRM.modules.deals.READRead deals records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Deal Contact Roles; Get Timelines
ZohoCRM.modules.deals.UPDATEUpdate deals records. Used by: Deal Contact Roles; Unblock email for a single record; Unblock emails for multiple records in a module
ZohoCRM.modules.DELETEDelete 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.CREATECreate emails records. Used by: Associate Email; Link Deal Email; Link Emails to Deals
ZohoCRM.modules.emails.READRead 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.ALLFull access to events records
ZohoCRM.modules.events.CREATECreate events records. Used by: Share Record Emails
ZohoCRM.modules.events.DELETEDelete events records. Used by: Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.events.READRead events records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count
ZohoCRM.modules.events.UPDATEUpdate events records. Used by: Cancel a Meeting
ZohoCRM.modules.forecasts.CREATECreate forecasts records. Used by: Share Record Emails
ZohoCRM.modules.forecasts.DELETEDelete forecasts records. Used by: Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.forecasts.READRead forecasts records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Search Records by Criteria, Word, Email, or Phone
ZohoCRM.modules.invoices.ALLFull access to invoices records
ZohoCRM.modules.invoices.CREATECreate invoices records. Used by: Create Email Drafts for a Record; Share Record Emails
ZohoCRM.modules.invoices.DELETEDelete invoices records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.invoices.READRead 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.UPDATEUpdate invoices records. Used by: Update Email Drafts for a Record; Update an Email Draft
ZohoCRM.modules.leads.ALLFull access to leads records. Used by: Download an inline image from an email
ZohoCRM.modules.leads.CREATECreate leads records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Merge Records
ZohoCRM.modules.leads.DELETEDelete leads records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.leads.READRead leads records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Download an email attachment; Get Merge Job Status
ZohoCRM.modules.leads.UPDATEUpdate 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.ALLFull access to notes records
ZohoCRM.modules.notes.CREATECreate notes records. Used by: Create Notes; Related Notes; Share Record Emails
ZohoCRM.modules.notes.DELETEDelete notes records. Used by: Delete a Specific Note; Notes; Related Note
ZohoCRM.modules.notes.READRead notes records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get a Specific Note; Notes
ZohoCRM.modules.notes.UPDATEUpdate notes records. Used by: Related Note; Related Notes; Update Notes
ZohoCRM.modules.potentials.CREATECreate potentials records. Used by: Merge Records
ZohoCRM.modules.potentials.READRead potentials records. Used by: Get Merge Job Status
ZohoCRM.modules.pricebooks.ALLFull access to pricebooks records
ZohoCRM.modules.pricebooks.CREATECreate pricebooks records
ZohoCRM.modules.pricebooks.DELETEDelete pricebooks records
ZohoCRM.modules.pricebooks.READRead pricebooks records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count
ZohoCRM.modules.pricebooks.UPDATEUpdate pricebooks records
ZohoCRM.modules.products.ALLFull access to products records
ZohoCRM.modules.products.CREATECreate products records. Used by: Share Record Emails
ZohoCRM.modules.products.DELETEDelete products records. Used by: Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.products.READRead products records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count
ZohoCRM.modules.products.UPDATEUpdate products records
ZohoCRM.modules.purchaseorders.ALLFull access to purchaseorders records
ZohoCRM.modules.purchaseorders.CREATECreate purchaseorders records. Used by: Create Email Drafts for a Record
ZohoCRM.modules.purchaseorders.DELETEDelete purchaseorders records. Used by: Delete an Email Draft
ZohoCRM.modules.purchaseorders.READRead purchaseorders records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Get an Email Draft
ZohoCRM.modules.purchaseorders.UPDATEUpdate 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.ALLFull access to quotes records
ZohoCRM.modules.quotes.CREATECreate quotes records. Used by: Convert Inventory Record; Create Email Drafts for a Record; Enroll Records to Cadences
ZohoCRM.modules.quotes.DELETEDelete quotes records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.quotes.READRead quotes records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Get an Email Draft
ZohoCRM.modules.quotes.UPDATEUpdate 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.READRequested 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.ALLFull access to salesorders records
ZohoCRM.modules.salesorders.CREATECreate salesorders records. Used by: Convert Inventory Record; Create Email Drafts for a Record
ZohoCRM.modules.salesorders.DELETEDelete salesorders records. Used by: Delete an Email Draft
ZohoCRM.modules.salesorders.READRead salesorders records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Get an Email Draft
ZohoCRM.modules.salesorders.UPDATEUpdate 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.ALLFull access to search records
ZohoCRM.modules.search.CREATECreate search records
ZohoCRM.modules.search.DELETEDelete search records
ZohoCRM.modules.search.READRead search records
ZohoCRM.modules.search.UPDATEUpdate search records
ZohoCRM.modules.services.ALLFull access to services records
ZohoCRM.modules.services.CREATECreate services records. Used by: Create service records in Zoho CRM
ZohoCRM.modules.services.DELETEDelete services records. Used by: Delete a service record by ID; Delete one or more service records
ZohoCRM.modules.services.READRead services records. Used by: Get services; Retrieve a specific service record by ID
ZohoCRM.modules.services.UPDATEUpdate services records. Used by: Update a specific service record by ID; Update service records
ZohoCRM.modules.solutions.ALLFull access to solutions records
ZohoCRM.modules.solutions.CREATECreate solutions records. Used by: Share Record Emails
ZohoCRM.modules.solutions.DELETEDelete solutions records. Used by: Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.solutions.READRead solutions records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count
ZohoCRM.modules.solutions.UPDATEUpdate solutions records
ZohoCRM.modules.tasks.ALLFull access to tasks records
ZohoCRM.modules.tasks.CREATECreate tasks records. Used by: Share Record Emails
ZohoCRM.modules.tasks.DELETEDelete tasks records. Used by: Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.tasks.READRead tasks records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Timelines; Module Record Count
ZohoCRM.modules.tasks.UPDATEUpdate tasks records
ZohoCRM.modules.UPDATEUpdate records in every module. Used by: Assign territories to a record; Assign territories to multiple records; Remove territories from a record
ZohoCRM.modules.vendors.ALLFull access to vendors records
ZohoCRM.modules.vendors.CREATECreate vendors records. Used by: Create Email Drafts for a Record; Enroll Records to Cadences; Merge Records
ZohoCRM.modules.vendors.DELETEDelete vendors records. Used by: Delete an Email Draft; Unshare Record Emails; Unshare emails in bulk
ZohoCRM.modules.vendors.READRead vendors records. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get Merge Job Status; Get Timelines
ZohoCRM.modules.vendors.UPDATEUpdate vendors records. Used by: Update Email Drafts for a Record; Update an Email Draft
ZohoCRM.notifications.ALLFull access to notifications. Used by: Create notification channels; Disable notification channels; Update full notification details
ZohoCRM.notifications.CREATECreate notifications. Used by: Create notification channels
ZohoCRM.notifications.DELETEDelete notifications. Used by: Disable notification channels
ZohoCRM.notifications.READRead notifications. Used by: List active notification channels
ZohoCRM.notifications.UPDATEUpdate notifications. Used by: Update full notification details; Update notification channel information
ZohoCRM.org.ALLFull access to org
ZohoCRM.org.CREATECreate org. Used by: Upload Organization Photo
ZohoCRM.org.DELETEDelete org. Used by: Delete the organization photo
ZohoCRM.org.READRequested by default. Read org. Used by: Get organization details; Organization photo
ZohoCRM.send_mail.all.CREATECreate send mail all. Used by: Send an email to a record
ZohoCRM.settings.ALLFull access to settings. Used by: Related Lists
ZohoCRM.settings.assignment_rules.CREATECreate settings assignment rules. Used by: Clone Assignment Rule; Create an Assignment Rule
ZohoCRM.settings.assignment_rules.DELETEDelete settings assignment rules. Used by: Delete an Assignment Rule
ZohoCRM.settings.assignment_rules.READRead settings assignment rules. Used by: Assignment Rule Associations; Assignment Rules; Assignment Rules Count
ZohoCRM.settings.assignment_rules.UPDATEUpdate settings assignment rules. Used by: Clone Assignment Rule Entries; Reorder Assignment Rule entries; Update a Specific Assignment Rule
ZohoCRM.settings.audit_logs.CREATECreate settings audit logs. Used by: Create an audit log export job
ZohoCRM.settings.audit_logs.READRead settings audit logs. Used by: Get audit log export jobs; Get the Status of the Export Audit Log Job
ZohoCRM.settings.automation_actions.CREATECreate settings automation actions. Used by: Create Field Update; Create an Automation Task; Webhooks
ZohoCRM.settings.automation_actions.DELETEDelete settings automation actions. Used by: Automation Task; Delete Field Update; Delete a webhook by ID
ZohoCRM.settings.automation_actions.READRead settings automation actions. Used by: Automation Task; Get Field Update By Id; Get Field Updates
ZohoCRM.settings.automation_actions.UPDATEUpdate settings automation actions. Used by: Automation Task; Update Field Update; Update an automation task definition by ID (full replacement)
ZohoCRM.settings.business_hours.CREATECreate settings business hours. Used by: Add shift hours; Business Hours Configuration; Holidays
ZohoCRM.settings.business_hours.DELETEDelete settings business hours. Used by: Delete a shift hour; Holiday
ZohoCRM.settings.business_hours.READRead settings business hours. Used by: A specific holiday; Business Hours Configuration; Get a shift hour
ZohoCRM.settings.business_hours.UPDATEUpdate settings business hours. Used by: A specific holiday; Business Hours Configuration; Multiple Holidays
ZohoCRM.settings.cadences.CREATECreate settings cadences. Used by: Activate Cadence; Clone a Cadence; Create cadence
ZohoCRM.settings.cadences.DELETEDelete settings cadences. Used by: Delete a Cadence
ZohoCRM.settings.cadences.READRead settings cadences. Used by: Get Cadence analytics; Get Cadence module actions count; Get Cadence records count
ZohoCRM.settings.cadences.UPDATEUpdate settings cadences. Used by: Cadence; Update multiple Cadences (bulk form)
ZohoCRM.settings.clientportal.ALLFull access to settings clientportal. Used by: Delete user type; Portal User Type; Portal User Types
ZohoCRM.settings.clientportal.CREATECreate settings clientportal. Used by: Invite portal users; Portal; Portal User Type
ZohoCRM.settings.clientportal.DELETEDelete settings clientportal. Used by: Delete user type; delete portal users
ZohoCRM.settings.clientportal.READRead settings clientportal. Used by: Invite portal users; List portal users; Portal User Type
ZohoCRM.settings.clientportal.UPDATEUpdate settings clientportal. Used by: Change status of portal users; Portal; Portal User Status
ZohoCRM.settings.currencies.ALLFull access to settings currencies
ZohoCRM.settings.currencies.CREATECreate settings currencies. Used by: Create currencies; Enable multi-currency
ZohoCRM.settings.currencies.READRead settings currencies. Used by: List currencies; Specific Currency
ZohoCRM.settings.currencies.UPDATEUpdate settings currencies. Used by: Currency; Update base currency; Update currencies
ZohoCRM.settings.custom_buttons.ALLFull access to settings custom buttons
ZohoCRM.settings.custom_links.ALLFull access to settings custom links
ZohoCRM.settings.custom_views.ALLFull access to settings custom views
ZohoCRM.settings.custom_views.CREATECreate settings custom views. Used by: CustomView creation
ZohoCRM.settings.custom_views.DELETEDelete settings custom views. Used by: Delete Custom Views
ZohoCRM.settings.custom_views.READRead settings custom views. Used by: Get All Custom Views; Get Custom View By Id
ZohoCRM.settings.custom_views.UPDATEUpdate settings custom views. Used by: Custom Views; CustomView update; Sort Order
ZohoCRM.settings.data_sharing.ALLFull access to settings data sharing. Used by: Data Sharing Settings
ZohoCRM.settings.data_sharing.READRead settings data sharing. Used by: Data Sharing Settings
ZohoCRM.settings.data_sharing.UPDATEUpdate settings data sharing. Used by: Data Sharing Settings
ZohoCRM.settings.duplicate_check_preference.CREATECreate settings duplicate check preference. Used by: Create Duplicate Check Preference
ZohoCRM.settings.duplicate_check_preference.DELETEDelete settings duplicate check preference. Used by: Delete Duplicate Check Preference
ZohoCRM.settings.duplicate_check_preference.READRead settings duplicate check preference. Used by: Get Duplicate Check Preference
ZohoCRM.settings.duplicate_check_preference.UPDATEUpdate settings duplicate check preference. Used by: Update Duplicate Check Preference
ZohoCRM.settings.emails.ALLFull access to settings emails. Used by: Send mail merge email
ZohoCRM.settings.emails.READRead settings emails. Used by: Get from addresses
ZohoCRM.settings.fields.ALLFull access to settings fields
ZohoCRM.settings.fields.CREATECreate settings fields. Used by: Create custom fields in a module
ZohoCRM.settings.fields.DELETEDelete settings fields. Used by: Delete a custom field; Delete a picklist field option
ZohoCRM.settings.fields.READRead settings fields. Used by: Get field metadata by ID; Get scheduled jobs for a field; List fields metadata
ZohoCRM.settings.fields.UPDATEUpdate settings fields. Used by: Replace Pick list values; Update a custom field; Update custom fields
ZohoCRM.settings.fiscal_year.READRead settings fiscal year. Used by: Get Fiscal Year Settings
ZohoCRM.settings.fiscal_year.UPDATEUpdate settings fiscal year. Used by: Update Fiscal Year Settings
ZohoCRM.settings.global_picklist.ALLFull access to settings global picklist. Used by: Get Picklist Value Associations; Replace Picklist Values
ZohoCRM.settings.global_picklist.CREATECreate settings global picklist. Used by: Create a Global Picklist
ZohoCRM.settings.global_picklist.DELETEDelete settings global picklist. Used by: Delete a Global Picklist; Delete a Global Picklist by ID
ZohoCRM.settings.global_picklist.READRead settings global picklist. Used by: Get All Global Picklists; Get Field Associations; Get Replaced Picklist Values
ZohoCRM.settings.global_picklist.UPDATEUpdate settings global picklist. Used by: Update a Global Picklist; Update a Global Picklist by ID
ZohoCRM.settings.intelligence.CREATECreate settings intelligence. Used by: Trigger organization-level enrichment for a CRM record
ZohoCRM.settings.intelligence.READRead settings intelligence. Used by: Get Zia Org Enrichment; Org Enrichment Details
ZohoCRM.settings.layouts.ALLFull access to settings layouts
ZohoCRM.settings.layouts.CREATECreate settings layouts. Used by: Activate Layout
ZohoCRM.settings.layouts.DELETEDelete settings layouts. Used by: Deactivate Layout; Delete a custom layout
ZohoCRM.settings.layouts.READRead settings layouts. Used by: Get layout by ID; Get layouts metadata
ZohoCRM.settings.layouts.UPDATEUpdate settings layouts. Used by: Update a custom layout
ZohoCRM.settings.macros.ALLFull access to settings macros
ZohoCRM.settings.mailmerge.CREATECreate settings mailmerge. Used by: Download mail merge document; Send mail merge document for signing; Send mail merge email
ZohoCRM.settings.map_dependency.CREATECreate settings map dependency. Used by: Create a field dependency for a layout
ZohoCRM.settings.map_dependency.DELETEDelete settings map dependency. Used by: Delete a field dependency
ZohoCRM.settings.map_dependency.READRead settings map dependency. Used by: Get a field dependency by ID; Get field dependencies for a layout
ZohoCRM.settings.map_dependency.UPDATEUpdate settings map dependency. Used by: Update an existing field dependency
ZohoCRM.settings.modules.ALLFull access to settings modules. Used by: Update locking reason of a locked record
ZohoCRM.settings.modules.CREATECreate settings modules. Used by: Create a custom module; Lock a record
ZohoCRM.settings.modules.DELETEDelete settings modules. Used by: Remove lock from a locked record
ZohoCRM.settings.modules.READRead settings modules. Used by: Call Preferences; Generate web-tab link for a module; Get Appointment Preferences
ZohoCRM.settings.modules.UPDATEUpdate settings modules. Used by: Call Preferences; Update Appointment Preferences; Update CRM modules
ZohoCRM.settings.pipeline.CREATECreate settings pipeline. Used by: Pipeline; Transfer Pipeline
ZohoCRM.settings.pipeline.READRead settings pipeline. Used by: Pipelines; Specific Pipeline
ZohoCRM.settings.pipeline.UPDATEUpdate settings pipeline. Used by: Pipeline
ZohoCRM.settings.profiles.ALLFull access to settings profiles
ZohoCRM.settings.profiles.CREATECreate settings profiles. Used by: Clone a CRM profile
ZohoCRM.settings.profiles.DELETEDelete settings profiles. Used by: Profile
ZohoCRM.settings.profiles.READRead settings profiles. Used by: Profile; Profiles
ZohoCRM.settings.profiles.UPDATEUpdate settings profiles. Used by: Profile; Specific Profile
ZohoCRM.settings.record_locking_configurations.CREATECreate settings record locking configurations. Used by: Create record locking configuration
ZohoCRM.settings.record_locking_configurations.DELETEDelete settings record locking configurations. Used by: Delete record locking configuration; Delete specific record locking configuration
ZohoCRM.settings.record_locking_configurations.READRead settings record locking configurations. Used by: Get record locking configuration; Get specific record locking configuration
ZohoCRM.settings.record_locking_configurations.UPDATEUpdate settings record locking configurations. Used by: Update record locking configuration; Update specific record locking configuration
ZohoCRM.settings.recycle_bin.DELETEDelete settings recycle bin. Used by: Delete a recycle-bin record permanently; Delete recycle-bin records
ZohoCRM.settings.recycle_bin.READRead settings recycle bin. Used by: Get a recycle-bin record; Get recycle-bin record count; Get recycle-bin records
ZohoCRM.settings.recycle_bin.UPDATEUpdate settings recycle bin. Used by: Empty the Recycle Bin; Restore a Recycle Bin record; Restore multiple Recycle Bin records
ZohoCRM.settings.related_lists.ALLFull access to settings related lists. Used by: Related Lists
ZohoCRM.settings.related_lists.READRead settings related lists. Used by: Related Lists
ZohoCRM.settings.roles.ALLFull access to settings roles
ZohoCRM.settings.roles.CREATECreate settings roles. Used by: Create a role
ZohoCRM.settings.roles.DELETEDelete settings roles. Used by: Delete a role
ZohoCRM.settings.roles.READRead settings roles. Used by: Get a role; Get all roles
ZohoCRM.settings.roles.UPDATEUpdate settings roles. Used by: Update a role
ZohoCRM.settings.scoring_rules.CREATECreate settings scoring rules. Used by: Clone a scoring rule; Scoring Rules
ZohoCRM.settings.scoring_rules.DELETEDelete settings scoring rules. Used by: Deactivate a scoring rule; Delete a scoring rules by ID; Scoring Rules
ZohoCRM.settings.scoring_rules.READRead settings scoring rules. Used by: Get scoring rule by ID; Scoring Rules
ZohoCRM.settings.scoring_rules.UPDATEUpdate settings scoring rules. Used by: Activate a scoring rule; Scoring Rules; Update a scoring rules by ID
ZohoCRM.settings.tab_groups.ALLFull access to settings tab groups
ZohoCRM.settings.tags.ALLFull access to settings tags. Used by: Get Tag Records Count; Merge Tags
ZohoCRM.settings.tags.CREATECreate settings tags. Used by: Tags
ZohoCRM.settings.tags.DELETEDelete settings tags. Used by: Delete tag by ID; Mass delete tags
ZohoCRM.settings.tags.READRead settings tags. Used by: Mass Delete Tags Status; Tags
ZohoCRM.settings.tags.UPDATEUpdate settings tags. Used by: Tags; Update tag by ID
ZohoCRM.settings.territories.ALLFull access to settings territories. Used by: Get scheduled territory run rule job status; Run territory assignment rules; Specific Territory User
ZohoCRM.settings.territories.CREATECreate settings territories. Used by: Create Territories
ZohoCRM.settings.territories.DELETEDelete settings territories. Used by: Delete a territory by ID; Delete territories; Remove territories from a user
ZohoCRM.settings.territories.READRead settings territories. Used by: Get all territories; Get child territories by parent territory ID; Get scheduled territory run rule job status
ZohoCRM.settings.territories.UPDATEUpdate settings territories. Used by: Add territories to a user; Run territory assignment rules; Update a specific territory by its ID
ZohoCRM.settings.unsubscribe.CREATECreate settings unsubscribe. Used by: Create Unsubscribe Link
ZohoCRM.settings.unsubscribe.DELETEDelete settings unsubscribe. Used by: Delete Unsubscribe Link by ID
ZohoCRM.settings.unsubscribe.READRead settings unsubscribe. Used by: Get Unsubscribe Link Associations; Get Unsubscribe Link by ID; Get Unsubscribe Links
ZohoCRM.settings.unsubscribe.UPDATEUpdate settings unsubscribe. Used by: Update Unsubscribe Link by ID; Update Unsubscribe Links
ZohoCRM.settings.user_groups.CREATECreate settings user groups. Used by: Create a user group
ZohoCRM.settings.user_groups.DELETEDelete settings user groups. Used by: Delete a user group
ZohoCRM.settings.user_groups.READRead 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.UPDATEUpdate settings user groups. Used by: Update a user group
ZohoCRM.settings.variable_groups.CREATECreate settings variable groups. Used by: Generate API Name
ZohoCRM.settings.variable_groups.READRead settings variable groups. Used by: Get variable group by ID; Variable Groups
ZohoCRM.settings.variable_groups.UPDATEUpdate settings variable groups. Used by: Update variable group by ID; Variable Groups
ZohoCRM.settings.variables.ALLFull access to settings variables
ZohoCRM.settings.variables.CREATECreate settings variables. Used by: Create variables; Generate API Name
ZohoCRM.settings.variables.DELETEDelete settings variables. Used by: Delete variables; Specific variable
ZohoCRM.settings.variables.READRead settings variables. Used by: Retrieve all variables; Variable Associations; specific variable
ZohoCRM.settings.variables.UPDATEUpdate settings variables. Used by: Specific variable; Update variables
ZohoCRM.settings.wizards.READRead settings wizards. Used by: Get all wizard configurations; Get wizard details
ZohoCRM.settings.workflow_rules.CREATECreate settings workflow rules. Used by: Create a workflow rule for a module
ZohoCRM.settings.workflow_rules.DELETEDelete settings workflow rules. Used by: Delete One or More Workflow Rules; Delete a workflow rule by ID
ZohoCRM.settings.workflow_rules.READRead 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.UPDATEUpdate 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.CREATECreate share accounts. Used by: Share a record
ZohoCRM.share.accounts.DELETEDelete share accounts. Used by: Revoke sharing on a record
ZohoCRM.share.accounts.READRead share accounts. Used by: Share Records
ZohoCRM.share.accounts.UPDATEUpdate share accounts. Used by: Update share permissions
ZohoCRM.share.bundles.CREATECreate share bundles. Used by: Share a record
ZohoCRM.share.bundles.DELETEDelete share bundles. Used by: Revoke sharing on a record
ZohoCRM.share.bundles.READRead share bundles. Used by: Share Records
ZohoCRM.share.bundles.UPDATEUpdate share bundles. Used by: Update share permissions
ZohoCRM.share.calls.CREATECreate share calls. Used by: Share a record
ZohoCRM.share.calls.DELETEDelete share calls. Used by: Revoke sharing on a record
ZohoCRM.share.calls.READRead share calls. Used by: Share Records
ZohoCRM.share.calls.UPDATEUpdate share calls. Used by: Update share permissions
ZohoCRM.share.campaigns.CREATECreate share campaigns. Used by: Share a record
ZohoCRM.share.campaigns.DELETEDelete share campaigns. Used by: Revoke sharing on a record
ZohoCRM.share.campaigns.READRead share campaigns. Used by: Share Records
ZohoCRM.share.campaigns.UPDATEUpdate share campaigns. Used by: Update share permissions
ZohoCRM.share.cases.CREATECreate share cases. Used by: Share a record
ZohoCRM.share.cases.DELETEDelete share cases. Used by: Revoke sharing on a record
ZohoCRM.share.cases.READRead share cases. Used by: Share Records
ZohoCRM.share.cases.UPDATEUpdate share cases. Used by: Update share permissions
ZohoCRM.share.contacts.CREATECreate share contacts. Used by: Share a record
ZohoCRM.share.contacts.DELETEDelete share contacts. Used by: Revoke sharing on a record
ZohoCRM.share.contacts.READRead share contacts. Used by: Share Records
ZohoCRM.share.contacts.UPDATEUpdate share contacts. Used by: Update share permissions
ZohoCRM.share.custom.CREATECreate share custom. Used by: Share a record
ZohoCRM.share.custom.DELETEDelete share custom. Used by: Revoke sharing on a record
ZohoCRM.share.custom.READRead share custom. Used by: Share Records
ZohoCRM.share.custom.UPDATEUpdate share custom. Used by: Update share permissions
ZohoCRM.share.deals.CREATECreate share deals. Used by: Share a record
ZohoCRM.share.deals.DELETEDelete share deals. Used by: Revoke sharing on a record
ZohoCRM.share.deals.READRead share deals. Used by: Share Records
ZohoCRM.share.deals.UPDATEUpdate share deals. Used by: Update share permissions
ZohoCRM.share.events.CREATECreate share events. Used by: Share a record
ZohoCRM.share.events.DELETEDelete share events. Used by: Revoke sharing on a record
ZohoCRM.share.events.READRead share events. Used by: Share Records
ZohoCRM.share.events.UPDATEUpdate share events. Used by: Update share permissions
ZohoCRM.share.invoices.CREATECreate share invoices. Used by: Share a record
ZohoCRM.share.invoices.DELETEDelete share invoices. Used by: Revoke sharing on a record
ZohoCRM.share.invoices.READRead share invoices. Used by: Share Records
ZohoCRM.share.invoices.UPDATEUpdate share invoices. Used by: Update share permissions
ZohoCRM.share.leads.CREATECreate share leads. Used by: Share a record
ZohoCRM.share.leads.DELETEDelete share leads. Used by: Revoke sharing on a record
ZohoCRM.share.leads.READRead share leads. Used by: Share Records
ZohoCRM.share.leads.UPDATEUpdate share leads. Used by: Update share permissions
ZohoCRM.share.pricebooks.CREATECreate share pricebooks. Used by: Share a record
ZohoCRM.share.pricebooks.DELETEDelete share pricebooks. Used by: Revoke sharing on a record
ZohoCRM.share.pricebooks.READRead share pricebooks. Used by: Share Records
ZohoCRM.share.pricebooks.UPDATEUpdate share pricebooks. Used by: Update share permissions
ZohoCRM.share.products.CREATECreate share products. Used by: Share a record
ZohoCRM.share.products.DELETEDelete share products. Used by: Revoke sharing on a record
ZohoCRM.share.products.READRead share products. Used by: Share Records
ZohoCRM.share.products.UPDATEUpdate share products. Used by: Update share permissions
ZohoCRM.share.purchaseorders.CREATECreate share purchaseorders. Used by: Share a record
ZohoCRM.share.purchaseorders.DELETEDelete share purchaseorders. Used by: Revoke sharing on a record
ZohoCRM.share.purchaseorders.READRead share purchaseorders. Used by: Share Records
ZohoCRM.share.purchaseorders.UPDATEUpdate share purchaseorders. Used by: Update share permissions
ZohoCRM.share.quotes.CREATECreate share quotes. Used by: Share a record
ZohoCRM.share.quotes.DELETEDelete share quotes. Used by: Revoke sharing on a record
ZohoCRM.share.quotes.READRead share quotes. Used by: Share Records
ZohoCRM.share.quotes.UPDATEUpdate share quotes. Used by: Update share permissions
ZohoCRM.share.salesorders.CREATECreate share salesorders. Used by: Share a record
ZohoCRM.share.salesorders.DELETEDelete share salesorders. Used by: Revoke sharing on a record
ZohoCRM.share.salesorders.READRead share salesorders. Used by: Share Records
ZohoCRM.share.salesorders.UPDATEUpdate share salesorders. Used by: Update share permissions
ZohoCRM.share.solutions.CREATECreate share solutions. Used by: Share a record
ZohoCRM.share.solutions.DELETEDelete share solutions. Used by: Revoke sharing on a record
ZohoCRM.share.solutions.READRead share solutions. Used by: Share Records
ZohoCRM.share.solutions.UPDATEUpdate share solutions. Used by: Update share permissions
ZohoCRM.share.tasks.CREATECreate share tasks. Used by: Share a record
ZohoCRM.share.tasks.DELETEDelete share tasks. Used by: Revoke sharing on a record
ZohoCRM.share.tasks.READRead share tasks. Used by: Share Records
ZohoCRM.share.tasks.UPDATEUpdate share tasks. Used by: Update share permissions
ZohoCRM.share.vendors.CREATECreate share vendors. Used by: Share a record
ZohoCRM.share.vendors.DELETEDelete share vendors. Used by: Revoke sharing on a record
ZohoCRM.share.vendors.READRead share vendors. Used by: Share Records
ZohoCRM.share.vendors.UPDATEUpdate share vendors. Used by: Update share permissions
ZohoCRM.templates.email.READRead templates email. Used by: Email Templates
ZohoCRM.templates.inventory.READRead templates inventory. Used by: Inventory Template; Inventory templates
ZohoCRM.users.ALLFull access to users. Used by: Specific Territory User; Territory User; Territory Users
ZohoCRM.users.CREATECreate users. Used by: Create User
ZohoCRM.users.DELETEDelete users. Used by: Delete a user from the organization; Get transfer and delete status; Remove territories from a user
ZohoCRM.users.READRead users. Used by: Bulk Search Records by Criteria, Word, Email, or Phone; Get a specific user; Get territories of a user
ZohoCRM.users.UPDATEUpdate users. Used by: Add territories to a user; Transfer and delete a user; Update a single user by user ID
ZohoCRM.zia.enrichment.CREATECreate zia enrichment. Used by: Zia Data Enrichment Configuration
ZohoCRM.zia.enrichment.DELETEDelete zia enrichment. Used by: Delete Zia Enrichment Configuration for a specific module
ZohoCRM.zia.enrichment.READRead zia enrichment. Used by: Data Enrichment; Get Zia Enrichment Configuration for a specific module
ZohoCRM.zia.enrichment.UPDATEUpdate zia enrichment. Used by: Update Zia Enrichment Configurations for a specific module
ZohoSign.documents.ALLFull access to ZohoSign documents. Used by: Send mail merge document for signing
ZohoWriter.documentEditor.ALLFull access to ZohoWriter documentEditor. Used by: Download mail merge document; Send mail merge document for signing; Send mail merge email
ZohoWriter.merge.ALLFull access to ZohoWriter merge. Used by: Download mail merge document; Send mail merge document for signing; Send mail merge email

Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.

Operation IDFamiliesMethodProvider path
createBulkReadJobreadPOST/crm/bulk/v8/read
getBulkReadJobDetailsreadGET/crm/bulk/v8/read/{jobId}
downloadBulkReadResultreadGET/crm/bulk/v8/read/{jobId}/result
createBulkWriteJobwritePOST/crm/bulk/v8/write
getBulkWriteJobDetailsreadGET/crm/bulk/v8/write/{jobId}
deleteAppointmentsSdeleteDELETE/crm/v8/Appointments__s
getAppointmentsSreadGET/crm/v8/Appointments__s
createAppointmentsSsend, writePOST/crm/v8/Appointments__s
updateAppointmentsSsend, writePUT/crm/v8/Appointments__s
deleteAppointmentByIddeleteDELETE/crm/v8/Appointments__s/{appointmentId}
getAppointmentByIdreadGET/crm/v8/Appointments__s/{appointmentId}
updateAppointmentByIdsend, writePUT/crm/v8/Appointments__s/{appointmentId}
deleteContactRolesdeleteDELETE/crm/v8/Contacts/roles
getContactRolesreadGET/crm/v8/Contacts/roles
createContactRoleswritePOST/crm/v8/Contacts/roles
updateContactRoleswritePUT/crm/v8/Contacts/roles
deleteContactRoledeleteDELETE/crm/v8/Contacts/roles/{role}
getContactRolereadGET/crm/v8/Contacts/roles/{role}
updateContactRolewritePUT/crm/v8/Contacts/roles/{role}
unlinkEmailsFromDealdeleteDELETE/crm/v8/Contacts/{contactId}/Emails/actions/link_record
linkEmailsToDealswritePOST/crm/v8/Contacts/{contactId}/Emails/actions/link_record
unlinkEmailFromRecorddeleteDELETE/crm/v8/Contacts/{contactId}/Emails/{messageId}/actions/link_record
linkEmailToRecordwritePOST/crm/v8/Contacts/{contactId}/Emails/{messageId}/actions/link_record
cancelMeetingssend, writePOST/crm/v8/Events/{event}/actions/cancel
getMassConvertJobStatusreadGET/crm/v8/Leads/actions/mass_convert
massConvertwritePOST/crm/v8/Leads/actions/mass_convert
getLeadConversionOptionsreadGET/crm/v8/Leads/{leadId}/__conversion_options
convertLeadsend, writePOST/crm/v8/Leads/{leadId}/actions/convert
deleteNotesModuledeleteDELETE/crm/v8/Notes
getNotesModulereadGET/crm/v8/Notes
createNotesModulewritePOST/crm/v8/Notes
updateNotesModulewritePUT/crm/v8/Notes
deleteNoteByIddeleteDELETE/crm/v8/Notes/{id}
getNoteByIdreadGET/crm/v8/Notes/{id}
updateNoteByIdwritePUT/crm/v8/Notes/{id}
deleteServicesSdeleteDELETE/crm/v8/Services__s
getServicesSreadGET/crm/v8/Services__s
createServicesSwritePOST/crm/v8/Services__s
updateServicesSwritePUT/crm/v8/Services__s
deleteServiceByIddeleteDELETE/crm/v8/Services__s/{id}
getServiceByIdreadGET/crm/v8/Services__s/{id}
updateServiceSByIdwritePUT/crm/v8/Services__s/{id}
getAvailableApisreadGET/crm/v8/__apis
createCompositeRequestadmin, delete, read, send, writePOST/crm/v8/__composite_requests
getFeatureDetailsreadGET/crm/v8/__features
getUserLicenseFeatureDetailsreadGET/crm/v8/__features/user_licenses
getFeatureSpecificDetailsreadGET/crm/v8/__features/{feature}
getZiaOrgEnrichmentreadGET/crm/v8/__zia_org_enrichment
submitOrgEnrichmentRequestwritePOST/crm/v8/__zia_org_enrichment
getOrgEnrichmentByIdreadGET/crm/v8/__zia_org_enrichment/{id}
disableNotificationsadmin, deleteDELETE/crm/v8/actions/watch
getNotificationsadmin, readGET/crm/v8/actions/watch
updateNotificationInfoadmin, writePATCH/crm/v8/actions/watch
createNotificationsadmin, writePOST/crm/v8/actions/watch
updateNotificationDetailsadmin, writePUT/crm/v8/actions/watch
executeCOQLQueryreadPOST/crm/v8/coql
getFilereadGET/crm/v8/files
uploadFileswritePOST/crm/v8/files
getOrganizationreadGET/crm/v8/org
getCurrenciesreadGET/crm/v8/org/currencies
createCurrenciesadmin, writePOST/crm/v8/org/currencies
updateCurrenciesadmin, writePUT/crm/v8/org/currencies
enableCurrencyadmin, writePOST/crm/v8/org/currencies/actions/enable
updateBaseCurrencyadmin, writePUT/crm/v8/org/currencies/actions/enable
getCurrencyByIdreadGET/crm/v8/org/currencies/{currency}
updateCurrencyByIdadmin, writePUT/crm/v8/org/currencies/{currency}
deleteOrgPhotoadmin, deleteDELETE/crm/v8/org/photo
getOrgPhotoreadGET/crm/v8/org/photo
uploadOrganizationPhotoadmin, writePOST/crm/v8/org/photo
getAppointmentPreferencereadGET/crm/v8/settings/appointment_preferences
updateAppointmentPreferenceadmin, writePUT/crm/v8/settings/appointment_preferences
getAuditLogExportsreadGET/crm/v8/settings/audit_log_export
createAuditLogExportadmin, readPOST/crm/v8/settings/audit_log_export
getAuditLogExportsByIdreadGET/crm/v8/settings/audit_log_export/{id}
getAssignmentRulesreadGET/crm/v8/settings/automation/assignment_rules
postAssignmentRulesadmin, writePOST/crm/v8/settings/automation/assignment_rules
getAssignmentRulesCountreadGET/crm/v8/settings/automation/assignment_rules/actions/count
deleteAssignmentRuleByIdadmin, deleteDELETE/crm/v8/settings/automation/assignment_rules/{id}
getAssignmentRuleByIdreadGET/crm/v8/settings/automation/assignment_rules/{id}
updateAssignmentRuleByIdadmin, writePUT/crm/v8/settings/automation/assignment_rules/{id}
getAssignmentRuleAssociationsreadGET/crm/v8/settings/automation/assignment_rules/{id}/actions/associations
cloneAssignmentRuleadmin, writePOST/crm/v8/settings/automation/assignment_rules/{id}/actions/clone
putCloneEntriesadmin, writePUT/crm/v8/settings/automation/assignment_rules/{id}/actions/clone_entries
putReorderEntriesadmin, writePUT/crm/v8/settings/automation/assignment_rules/{id}/actions/reorder_entries
getCadencesreadGET/crm/v8/settings/automation/cadences
postCadencesadmin, writePOST/crm/v8/settings/automation/cadences
putUpdateCadencesadmin, writePUT/crm/v8/settings/automation/cadences
getCadenceModuleActionsCountreadGET/crm/v8/settings/automation/cadences/actions/count
listCadencesRecordsCountreadGET/crm/v8/settings/automation/cadences/actions/records_count
deleteSingleCadenceadmin, deleteDELETE/crm/v8/settings/automation/cadences/{id}
getCadencereadGET/crm/v8/settings/automation/cadences/{id}
putUpdateCadenceadmin, writePUT/crm/v8/settings/automation/cadences/{id}
postActivateadmin, writePOST/crm/v8/settings/automation/cadences/{id}/actions/activate
getCadenceAnalyticsreadGET/crm/v8/settings/automation/cadences/{id}/actions/analytics
postCloneCadencesadmin, writePOST/crm/v8/settings/automation/cadences/{id}/actions/clone
postDeactivateadmin, writePOST/crm/v8/settings/automation/cadences/{id}/actions/deactivate
postPublishadmin, writePOST/crm/v8/settings/automation/cadences/{id}/actions/publish
deleteFieldUpdatesadmin, deleteDELETE/crm/v8/settings/automation/field_updates
getFieldUpdatesreadGET/crm/v8/settings/automation/field_updates
createFieldUpdatesadmin, writePOST/crm/v8/settings/automation/field_updates
deleteFieldUpdateByIdadmin, deleteDELETE/crm/v8/settings/automation/field_updates/{id}
getFieldUpdateByIdreadGET/crm/v8/settings/automation/field_updates/{id}
updateFieldUpdateByIdadmin, writePUT/crm/v8/settings/automation/field_updates/{id}
deleteScoringRulesadmin, deleteDELETE/crm/v8/settings/automation/scoring_rules
getScoringRulesreadGET/crm/v8/settings/automation/scoring_rules
postScoringRulesadmin, writePOST/crm/v8/settings/automation/scoring_rules
putScoringRulesadmin, writePUT/crm/v8/settings/automation/scoring_rules
deleteScoringRuleByIdadmin, deleteDELETE/crm/v8/settings/automation/scoring_rules/{ruleId}
getScoringRuleByIdreadGET/crm/v8/settings/automation/scoring_rules/{ruleId}
putScoringRuleByIdadmin, writePUT/crm/v8/settings/automation/scoring_rules/{ruleId}
deleteActivateadmin, deleteDELETE/crm/v8/settings/automation/scoring_rules/{ruleId}/actions/activate
putActivateadmin, writePUT/crm/v8/settings/automation/scoring_rules/{ruleId}/actions/activate
postCloneadmin, writePOST/crm/v8/settings/automation/scoring_rules/{ruleId}/actions/clone
deleteTasksadmin, deleteDELETE/crm/v8/settings/automation/tasks
getWorkflowTasksreadGET/crm/v8/settings/automation/tasks
createWorkflowTasksadmin, writePOST/crm/v8/settings/automation/tasks
updateWorkflowTaskadmin, writePUT/crm/v8/settings/automation/tasks
deleteTaskByIdadmin, deleteDELETE/crm/v8/settings/automation/tasks/{id}
getTaskByIdreadGET/crm/v8/settings/automation/tasks/{id}
updateWorkflowTaskByIdadmin, writePUT/crm/v8/settings/automation/tasks/{id}
getWebhookFailuresreadGET/crm/v8/settings/automation/webhook_failures
deleteWebhooksadmin, deleteDELETE/crm/v8/settings/automation/webhooks
getWebhooksadmin, readGET/crm/v8/settings/automation/webhooks
createWebhooksadmin, writePOST/crm/v8/settings/automation/webhooks
updateWebhooksadmin, writePUT/crm/v8/settings/automation/webhooks
getWebhookAssociatedModulesreadGET/crm/v8/settings/automation/webhooks/actions/associated_modules
getWebhookUsageReportsreadGET/crm/v8/settings/automation/webhooks/actions/usage_reports
deleteWebhooksByIdadmin, deleteDELETE/crm/v8/settings/automation/webhooks/{webhookId}
getWebhookByIdadmin, readGET/crm/v8/settings/automation/webhooks/{webhookId}
updateWebhookByIdadmin, writePUT/crm/v8/settings/automation/webhooks/{webhookId}
deleteWorkflowRulesadmin, deleteDELETE/crm/v8/settings/automation/workflow_rules
getWorkflowRulesreadGET/crm/v8/settings/automation/workflow_rules
postWorkflowRuleadmin, writePOST/crm/v8/settings/automation/workflow_rules
updateWorkflowRuleadmin, writePUT/crm/v8/settings/automation/workflow_rules
getWorkflowRulesActionsCountreadGET/crm/v8/settings/automation/workflow_rules/actions/actions_count
getModuleSpecificActionsCountreadGET/crm/v8/settings/automation/workflow_rules/actions/module_specific_count
reorderWorkflowRulesadmin, writePUT/crm/v8/settings/automation/workflow_rules/actions/reorder
getWorkflowRulesCountreadGET/crm/v8/settings/automation/workflow_rules/actions/rules_count
deleteWorkflowRuleByIdadmin, deleteDELETE/crm/v8/settings/automation/workflow_rules/{id}
getWorkflowRuleByIdreadGET/crm/v8/settings/automation/workflow_rules/{id}
updateWorkflowRuleByIdadmin, writePUT/crm/v8/settings/automation/workflow_rules/{id}
getWorkflowRuleUsagereadGET/crm/v8/settings/automation/workflow_rules/{workflowRuleId}/actions/usage
getBusinessHoursreadGET/crm/v8/settings/business_hours
createBusinessHoursadmin, writePOST/crm/v8/settings/business_hours
updateBusinessHoursadmin, writePUT/crm/v8/settings/business_hours
getShiftsreadGET/crm/v8/settings/business_hours/shift_hours
createShiftsadmin, writePOST/crm/v8/settings/business_hours/shift_hours
updateShiftHoursadmin, writePUT/crm/v8/settings/business_hours/shift_hours
deleteSingleShiftHouradmin, deleteDELETE/crm/v8/settings/business_hours/shift_hours/{shift}
getSingleShiftHourreadGET/crm/v8/settings/business_hours/shift_hours/{shift}
updateSingleShiftHouradmin, writePUT/crm/v8/settings/business_hours/shift_hours/{shift}
getCallPreferencesreadGET/crm/v8/settings/call_preferences
updateCallPreferencesadmin, writePUT/crm/v8/settings/call_preferences
deleteCustomViewadmin, deleteDELETE/crm/v8/settings/custom_views
getCustomViewsreadGET/crm/v8/settings/custom_views
createCustomViewadmin, writePOST/crm/v8/settings/custom_views
updateCustomViewsBulkadmin, writePUT/crm/v8/settings/custom_views
changeSortadmin, writePUT/crm/v8/settings/custom_views/actions/change_sort
getCustomViewByIdreadGET/crm/v8/settings/custom_views/{id}
updateCustomViewadmin, writePUT/crm/v8/settings/custom_views/{id}
changeSortByIdadmin, writePUT/crm/v8/settings/custom_views/{id}/actions/change_sort
getDataSharingreadGET/crm/v8/settings/data_sharing
updateDataSharingadmin, writePUT/crm/v8/settings/data_sharing
deleteDuplicateCheckPreferenceadmin, deleteDELETE/crm/v8/settings/duplicate_check_preference
getDuplicateCheckPreferencereadGET/crm/v8/settings/duplicate_check_preference
createDuplicateCheckPreferenceadmin, writePOST/crm/v8/settings/duplicate_check_preference
updateDuplicateCheckPreferenceadmin, writePUT/crm/v8/settings/duplicate_check_preference
getEmailTemplatesreadGET/crm/v8/settings/email_templates
getFromAddressesreadGET/crm/v8/settings/emails/actions/from_addresses
getFieldsreadGET/crm/v8/settings/fields
updateFieldadmin, writePATCH/crm/v8/settings/fields
createFieldsadmin, writePOST/crm/v8/settings/fields
deleteCustomFieldadmin, deleteDELETE/crm/v8/settings/fields/{fieldId}
getFieldsWithIDreadGET/crm/v8/settings/fields/{fieldId}
putFieldsWithIdadmin, writePATCH/crm/v8/settings/fields/{fieldId}
postReplacePickListValuesadmin, writePOST/crm/v8/settings/fields/{fieldId}/actions/replace_pick_list_values
getScheduledJobsreadGET/crm/v8/settings/fields/{fieldId}/actions/scheduled_jobs
getPickListValuesreadGET/crm/v8/settings/fields/{fieldId}/pick_list_values
deletePickListValuesByPickListValueidadmin, deleteDELETE/crm/v8/settings/fields/{fieldId}/pick_list_values/{pickListValueId}
getPickListValuesByPickListValueidreadGET/crm/v8/settings/fields/{fieldId}/pick_list_values/{pickListValueId}
getFiscalYearreadGET/crm/v8/settings/fiscal_year
updateFiscalYearadmin, writePUT/crm/v8/settings/fiscal_year
deleteGlobalPicklistsadmin, deleteDELETE/crm/v8/settings/global_picklists
getBulkGlobalPicklistsreadGET/crm/v8/settings/global_picklists
updateGlobalPicklistadmin, writePATCH/crm/v8/settings/global_picklists
createGlobalPicklistadmin, writePOST/crm/v8/settings/global_picklists
deleteGlobalPicklistadmin, deleteDELETE/crm/v8/settings/global_picklists/{id}
getSingleGlobalPicklistsreadGET/crm/v8/settings/global_picklists/{id}
updateGlobalPicklistByIdadmin, writePATCH/crm/v8/settings/global_picklists/{id}
getGlobalPickListFieldAssociationsreadGET/crm/v8/settings/global_picklists/{id}/actions/associations
getPickListValuesAssociationsreadGET/crm/v8/settings/global_picklists/{id}/actions/pick_list_values_associations
replacePicklistValuesadmin, writePOST/crm/v8/settings/global_picklists/{id}/actions/replace_picklist_values
getReplacedValuesreadGET/crm/v8/settings/global_picklists/{id}/actions/replaced_values
getHolidaysreadGET/crm/v8/settings/holidays
createHolidaysadmin, writePOST/crm/v8/settings/holidays
updateHolidaysadmin, writePUT/crm/v8/settings/holidays
deleteHolidayadmin, deleteDELETE/crm/v8/settings/holidays/{holidayId}
getHolidayreadGET/crm/v8/settings/holidays/{holidayId}
updateHolidayadmin, writePUT/crm/v8/settings/holidays/{holidayId}
getInventoryTemplatesreadGET/crm/v8/settings/inventory_templates
getInventoryTemplateByIdreadGET/crm/v8/settings/inventory_templates/{templateId}
getLayoutsreadGET/crm/v8/settings/layouts
deleteLayoutadmin, deleteDELETE/crm/v8/settings/layouts/{id}
getLayoutByIdreadGET/crm/v8/settings/layouts/{id}
updateLayoutadmin, writePATCH/crm/v8/settings/layouts/{id}
layoutDeactivateadmin, deleteDELETE/crm/v8/settings/layouts/{id}/actions/activate
activateLayoutadmin, writePOST/crm/v8/settings/layouts/{id}/actions/activate
getMapDependencyreadGET/crm/v8/settings/layouts/{layoutId}/map_dependency
createMapDependencyadmin, writePOST/crm/v8/settings/layouts/{layoutId}/map_dependency
deleteMapDependencyadmin, deleteDELETE/crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId}
getMapDependencyByIdreadGET/crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId}
updateMapDependencyadmin, writePUT/crm/v8/settings/layouts/{layoutId}/map_dependency/{dependencyId}
getGenerateLinkreadGET/crm/v8/settings/module/{moduleid}/actions/generate_link
getModulesreadGET/crm/v8/settings/modules
createModulesadmin, writePOST/crm/v8/settings/modules
updateModulesadmin, writePUT/crm/v8/settings/modules
getModuleByApiNamereadGET/crm/v8/settings/modules/{moduleIdentifier}
updateModuleByApiNameadmin, writePUT/crm/v8/settings/modules/{moduleIdentifier}
getPipelinesreadGET/crm/v8/settings/pipeline
updatePipelinesadmin, writePATCH/crm/v8/settings/pipeline
createPipelineadmin, writePOST/crm/v8/settings/pipeline
replacePipelinesadmin, writePUT/crm/v8/settings/pipeline
transferAndDeletePipelinesadmin, deletePOST/crm/v8/settings/pipeline/actions/transfer
getPipelinereadGET/crm/v8/settings/pipeline/{pipelineIdentifier}
updatePipelineByIdadmin, writePATCH/crm/v8/settings/pipeline/{pipelineIdentifier}
replacePipelineByIdadmin, writePUT/crm/v8/settings/pipeline/{pipelineIdentifier}
getPortalsreadGET/crm/v8/settings/portals
createPortaladmin, writePOST/crm/v8/settings/portals
getPortalreadGET/crm/v8/settings/portals/{portal}
updatePortaladmin, writePUT/crm/v8/settings/portals/{portal}
getPortalUserTypesreadGET/crm/v8/settings/portals/{portal}/user_type
createPortalUserTypeadmin, writePOST/crm/v8/settings/portals/{portal}/user_type
deletePortalUserTypeadmin, deleteDELETE/crm/v8/settings/portals/{portal}/user_type/{userTypeId}
getPortalUserTypereadGET/crm/v8/settings/portals/{portal}/user_type/{userTypeId}
updatePortalUserTypeadmin, writePUT/crm/v8/settings/portals/{portal}/user_type/{userTypeId}
deletePortalUsersadmin, deleteDELETE/crm/v8/settings/portals/{portal}/user_type/{userType}/users
getPortalUsersreadGET/crm/v8/settings/portals/{portal}/user_type/{userType}/users
transferPortalUsersadmin, writePOST/crm/v8/settings/portals/{portal}/user_type/{userType}/users/action/transfer
changePortalUsersStatusBulkadmin, writePUT/crm/v8/settings/portals/{portal}/user_type/{userType}/users/actions/change_status
changePortalUsersStatusadmin, writePUT/crm/v8/settings/portals/{portal}/user_type/{userType}/users/{recordId}/actions/change_status
getProfilesreadGET/crm/v8/settings/profiles
deleteProfileadmin, deleteDELETE/crm/v8/settings/profiles/{id}
getProfilereadGET/crm/v8/settings/profiles/{id}
patchProfileadmin, writePATCH/crm/v8/settings/profiles/{id}
updateProfileadmin, writePUT/crm/v8/settings/profiles/{id}
cloneProfileadmin, writePOST/crm/v8/settings/profiles/{id}/actions/clone
deleteRecordLockingConfigurationadmin, deleteDELETE/crm/v8/settings/record_locking_configurations
getRecordLockingConfigurationreadGET/crm/v8/settings/record_locking_configurations
createRecordLockingConfigurationadmin, writePOST/crm/v8/settings/record_locking_configurations
updateRecordLockingConfigurationadmin, writePUT/crm/v8/settings/record_locking_configurations
deleteRecordLockingConfigurationPassingIdInURLadmin, deleteDELETE/crm/v8/settings/record_locking_configurations/{id}
getRecordLockingConfigurationPassingIdInURLreadGET/crm/v8/settings/record_locking_configurations/{id}
updateRecordLockingConfigurationPassingIdInURLadmin, writePUT/crm/v8/settings/record_locking_configurations/{id}
deleteRecycleBinRecordsadmin, deleteDELETE/crm/v8/settings/recycle_bin
getRecycleBinRecordsreadGET/crm/v8/settings/recycle_bin
getRecycleBinCountsreadGET/crm/v8/settings/recycle_bin/actions/count
emptyRecycleBinadmin, deletePOST/crm/v8/settings/recycle_bin/actions/empty
restoreRecycleBinRecordsadmin, writePOST/crm/v8/settings/recycle_bin/actions/restore
deleteRecycleBinRecordadmin, deleteDELETE/crm/v8/settings/recycle_bin/{recordId}
getRecycleBinRecordreadGET/crm/v8/settings/recycle_bin/{recordId}
restoreRecycleBinRecordadmin, writePOST/crm/v8/settings/recycle_bin/{recordId}/actions/restore
getRelatedListsreadGET/crm/v8/settings/related_lists
getRolesreadGET/crm/v8/settings/roles
createRolesadmin, writePOST/crm/v8/settings/roles
updateRolesadmin, writePUT/crm/v8/settings/roles
deleteRoleadmin, deleteDELETE/crm/v8/settings/roles/{role}
getRolereadGET/crm/v8/settings/roles/{role}
updateRoleadmin, writePUT/crm/v8/settings/roles/{role}
getServicePreferencereadGET/crm/v8/settings/service_preferences
updateServicePreferenceadmin, writePUT/crm/v8/settings/service_preferences
getTagsreadGET/crm/v8/settings/tags
createTagsadmin, writePOST/crm/v8/settings/tags
updateTagsadmin, writePUT/crm/v8/settings/tags
getMassDeleteTagsStatusreadGET/crm/v8/settings/tags/actions/mass_delete
massDeleteTagsadmin, deletePOST/crm/v8/settings/tags/actions/mass_delete
deleteTagsadmin, deleteDELETE/crm/v8/settings/tags/{id}
updateTagByIdadmin, writePUT/crm/v8/settings/tags/{id}
mergeTagsadmin, writePOST/crm/v8/settings/tags/{id}/actions/merge
getTagRecordsCountreadGET/crm/v8/settings/tags/{id}/actions/records_count
deleteTerritoriesadmin, deleteDELETE/crm/v8/settings/territories
getTerritoriesreadGET/crm/v8/settings/territories
createTerritoriesadmin, writePOST/crm/v8/settings/territories
updateTerritoriesadmin, writePUT/crm/v8/settings/territories
getTerritoryAssociatedUsersCountreadGET/crm/v8/settings/territories/actions/associated_users_count
runTerritoryRulesadmin, writePOST/crm/v8/settings/territories/actions/run_rules
getTerritoryScheduledRunRuleJobsreadGET/crm/v8/settings/territories/actions/scheduled_run_rule_jobs
transferAndDeleteTerritoriesadmin, deletePOST/crm/v8/settings/territories/actions/transfer_and_delete
deleteTerritoryByIdadmin, deleteDELETE/crm/v8/settings/territories/{id}
getTerritoryByIdreadGET/crm/v8/settings/territories/{id}
updateTerritoryByIdadmin, writePUT/crm/v8/settings/territories/{id}
getChildTerritoriesByParentIdreadGET/crm/v8/settings/territories/{id}/__child_territories
transferAndDeleteTerritoryByIdadmin, deletePOST/crm/v8/settings/territories/{id}/actions/transfer_and_delete
deassociateUsersFromTerritoriesadmin, deleteDELETE/crm/v8/settings/territories/{territory}/users
getTerritoryUsersreadGET/crm/v8/settings/territories/{territory}/users
associateUsersToTerritoryadmin, writePUT/crm/v8/settings/territories/{territory}/users
deassociateUserFromSpecificTerritoryadmin, deleteDELETE/crm/v8/settings/territories/{territory}/users/{user}
getUserDetailsFromTerritoryreadGET/crm/v8/settings/territories/{territory}/users/{user}
associateUserToSpecificTerritoryadmin, writePUT/crm/v8/settings/territories/{territory}/users/{user}
getAssociationsreadGET/crm/v8/settings/unsubscribe_link/actions/associations
getUnsubscribeLinksreadGET/crm/v8/settings/unsubscribe_links
postUnsubscribeLinksadmin, writePOST/crm/v8/settings/unsubscribe_links
putUnsubscribeLinksadmin, writePUT/crm/v8/settings/unsubscribe_links
deleteUnsubscribeLinksByIdadmin, deleteDELETE/crm/v8/settings/unsubscribe_links/{id}
getUnsubscribeLinkByIdreadGET/crm/v8/settings/unsubscribe_links/{id}
putUnsubscribeLinksByIdadmin, writePUT/crm/v8/settings/unsubscribe_links/{id}
getUserGroupsreadGET/crm/v8/settings/user_groups
createGroupadmin, writePOST/crm/v8/settings/user_groups
getUserGroupAssociatedUsersCountreadGET/crm/v8/settings/user_groups/actions/associated_users_count
deleteGroupadmin, deleteDELETE/crm/v8/settings/user_groups/{group}
getGroupreadGET/crm/v8/settings/user_groups/{group}
updateGroupadmin, writePUT/crm/v8/settings/user_groups/{group}
getUserGroupAssociationsreadGET/crm/v8/settings/user_groups/{group}/actions/associations
getUserGroupSourcesCountreadGET/crm/v8/settings/user_groups/{group}/actions/sources_count
getUserGroupSourcesreadGET/crm/v8/settings/user_groups/{group}/sources
getVariableGroupsreadGET/crm/v8/settings/variable_groups
updateVariableGroupsadmin, writePUT/crm/v8/settings/variable_groups
generateAPINameadmin, writePOST/crm/v8/settings/variable_groups/actions/generate_api_name
getVariableGroupByIdreadGET/crm/v8/settings/variable_groups/{id}
updateVariableGroupByIdadmin, writePUT/crm/v8/settings/variable_groups/{id}
deleteVariablesadmin, deleteDELETE/crm/v8/settings/variables
getVariablesadmin, readGET/crm/v8/settings/variables
createVariablesadmin, writePOST/crm/v8/settings/variables
updateVariablesadmin, writePUT/crm/v8/settings/variables
postGenerateApiNameadmin, writePOST/crm/v8/settings/variables/actions/generate_api_name
deleteVariablesByIdadmin, deleteDELETE/crm/v8/settings/variables/{id}
getVariableByIdadmin, readGET/crm/v8/settings/variables/{id}
updateVariableByIdadmin, writePUT/crm/v8/settings/variables/{id}
getVariableAssociationsreadGET/crm/v8/settings/variables/{id}/actions/associations
getAllWizardsreadGET/crm/v8/settings/wizards
getWizardDetailsreadGET/crm/v8/settings/wizards/{id}
getZiaEnrichmentConfigurationreadGET/crm/v8/settings/zia/data_enrichment
createZiaEnrichmentConfigurationsadmin, writePOST/crm/v8/settings/zia/data_enrichment
deleteZiaEnrichmentConfigurationadmin, deleteDELETE/crm/v8/settings/zia/data_enrichment/{id}
getSpecificZiaEnrichmentConfigurationreadGET/crm/v8/settings/zia/data_enrichment/{id}
updateZiaEnrichmentConfigurationsadmin, writePUT/crm/v8/settings/zia/data_enrichment/{id}
getUsersreadGET/crm/v8/users
createUseradmin, send, writePOST/crm/v8/users
updateUseradmin, writePUT/crm/v8/users
getTransferAPIStatusreadGET/crm/v8/users/actions/transfer
getTransferStatusreadGET/crm/v8/users/actions/transfer_and_delete
userTransferWithoutIdadmin, deletePOST/crm/v8/users/actions/transfer_and_delete
userTransferAPIadmin, writePOST/crm/v8/users/{userId}/actions/transfer
userTransferadmin, deletePOST/crm/v8/users/{userId}/actions/transfer_and_delete
getValidateBeforeTransferStatusreadGET/crm/v8/users/{userId}/actions/validate_before_transfer
deleteUseradmin, deleteDELETE/crm/v8/users/{user}
getSingleUserreadGET/crm/v8/users/{user}
updateSingleUseradmin, writePUT/crm/v8/users/{user}
getAssociatedGroupsForUserreadGET/crm/v8/users/{user}/actions/associated_groups
removeTerritoriesfromUseradmin, deleteDELETE/crm/v8/users/{user}/territories
getTerritoriesOfUserreadGET/crm/v8/users/{user}/territories
associateTerritoriesToUseradmin, writePUT/crm/v8/users/{user}/territories
removeSpecificTerritoriesfromUseradmin, deleteDELETE/crm/v8/users/{user}/territories/{territory}
getSpecificTerritoryOfUserreadGET/crm/v8/users/{user}/territories/{territory}
getWorkflowConfigurationsreadGET/crm/v8/workflow_configurations
getRecordCountreadGET/crm/v8/{moduleApiName}/actions/count
fetchFullDataForMultipleRecordsreadGET/crm/v8/{moduleApiName}/actions/fetch_full_data
shareBulkEmailswritePOST/crm/v8/{moduleApiName}/actions/share_emails
unshareBulkEmailswritePOST/crm/v8/{moduleApiName}/actions/unshare_emails
getEmailSharingDetailreadGET/crm/v8/{moduleApiName}/{id}/__emails_sharing_details
convertInventorywritePOST/crm/v8/{moduleApiName}/{id}/actions/convert
fetchFullDataForSingleRecordreadGET/crm/v8/{moduleApiName}/{id}/actions/fetch_full_data
shareEmailswritePOST/crm/v8/{moduleApiName}/{id}/actions/share_emails
unshareEmailswritePOST/crm/v8/{moduleApiName}/{id}/actions/unshare_emails
getAttachmentsreadGET/crm/v8/{moduleApiName}/{recordId}/Attachments
uploadAttachmentwritePOST/crm/v8/{moduleApiName}/{recordId}/Attachments
deleteAttachmentdeleteDELETE/crm/v8/{moduleApiName}/{recordId}/Attachments/{id}
getAttachmentByIdreadGET/crm/v8/{moduleApiName}/{recordId}/Attachments/{id}
postDownloadMailMergereadPOST/crm/v8/{moduleApiName}/{recordId}/actions/download_mail_merge
getRelatedRecordsCountreadPOST/crm/v8/{moduleApiName}/{recordId}/actions/get_related_records_count
postSendMailMergesend, writePOST/crm/v8/{moduleApiName}/{recordId}/actions/send_mail_merge
deleteShareRecordsadmin, deleteDELETE/crm/v8/{moduleApiName}/{recordId}/actions/share
getShareRecordsreadGET/crm/v8/{moduleApiName}/{recordId}/actions/share
createShareRecordsadmin, send, writePOST/crm/v8/{moduleApiName}/{recordId}/actions/share
updateShareRecordsadmin, send, writePUT/crm/v8/{moduleApiName}/{recordId}/actions/share
postSignMailMergesend, writePOST/crm/v8/{moduleApiName}/{recordId}/actions/sign_mail_merge
sendMailsend, writePOST/crm/v8/{moduleName}/{id}/actions/send_mail
getRecordLockingInformationOfTheRecordreadGET/crm/v8/{moduleName}/{recordId}/Locking_Information__s
lockRecordwritePOST/crm/v8/{moduleName}/{recordId}/Locking_Information__s
removeLockFromLockedRecorddeleteDELETE/crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId}
getRecordLockingInformationByIdreadGET/crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId}
updateReasonofLockedRecordwritePUT/crm/v8/{moduleName}/{recordId}/Locking_Information__s/{lockId}
deleteRecordsdeleteDELETE/crm/v8/{module}
getRecordsreadGET/crm/v8/{module}
createRecordssend, writePOST/crm/v8/{module}
updateRecordssend, writePUT/crm/v8/{module}
postAddTagswritePOST/crm/v8/{module}/actions/add_tags
assignTerritoriesToRecordswritePOST/crm/v8/{module}/actions/assign_territories
changeOwnerBulksend, writePOST/crm/v8/{module}/actions/change_owner
postEnrolInCadencessend, writePOST/crm/v8/{module}/actions/enrol_in_cadences
getMassChangeOwnerStatusreadGET/crm/v8/{module}/actions/mass_change_owner
massChangeOwnerwritePOST/crm/v8/{module}/actions/mass_change_owner
getMassDeleteJobStatusreadGET/crm/v8/{module}/actions/mass_delete
massDeletedeletePOST/crm/v8/{module}/actions/mass_delete
getMassUpdateStatusreadGET/crm/v8/{module}/actions/mass_update
massUpdateRecordswritePOST/crm/v8/{module}/actions/mass_update
getScheduledInviteUsersInforeadGET/crm/v8/{module}/actions/portal_invite
inviteUsersadmin, send, writePOST/crm/v8/{module}/actions/portal_invite
postRemoveTagswritePOST/crm/v8/{module}/actions/remove_tags
removeTerritoriesFromRecordswritePOST/crm/v8/{module}/actions/remove_territories
unblockEmailByModulewritePOST/crm/v8/{module}/actions/unblock_email
postUnenrolFromCadenceswritePOST/crm/v8/{module}/actions/unenrol_from_cadences
bulkSearchRecordsreadPOST/crm/v8/{module}/bulk/search
getDeletedRecordsreadGET/crm/v8/{module}/deleted
searchRecordsreadGET/crm/v8/{module}/search
upsertRecordssend, writePOST/crm/v8/{module}/upsert
deleteContactRoleRelationsdeleteDELETE/crm/v8/{module}/{dealId}/Contact_Roles
getAssociatedContactRolesreadGET/crm/v8/{module}/{dealId}/Contact_Roles
upsertContactRoleRelationswritePUT/crm/v8/{module}/{dealId}/Contact_Roles
deleteContactRoleRelationdeleteDELETE/crm/v8/{module}/{dealId}/Contact_Roles/{contactId}
getDealContactRoleForContactreadGET/crm/v8/{module}/{dealId}/Contact_Roles/{contactId}
associateContactRoleToDealwritePUT/crm/v8/{module}/{dealId}/Contact_Roles/{contactId}
postAddTagsWithIdwritePOST/crm/v8/{module}/{id}/actions/add_tags
postRemoveTagsWithIdwritePOST/crm/v8/{module}/{id}/actions/remove_tags
unblockEmailByIdwritePOST/crm/v8/{module}/{id}/actions/unblock_email
getMergeJobStatusreadGET/crm/v8/{module}/{masterRecordId}/actions/merge
mergeRecordsdelete, writePOST/crm/v8/{module}/{masterRecordId}/actions/merge
deleteRecorddeleteDELETE/crm/v8/{module}/{recordId}
getRecordreadGET/crm/v8/{module}/{recordId}
updateRecordsend, writePUT/crm/v8/{module}/{recordId}
downloadEmailAttachmentsreadGET/crm/v8/{module}/{recordId}/Emails/actions/download_attachments
getDownloadInlineImagesreadGET/crm/v8/{module}/{recordId}/Emails/actions/download_inline_images
getTimelinesreadGET/crm/v8/{module}/{recordId}/__timeline
associateEmailwritePOST/crm/v8/{module}/{recordId}/actions/associate_email
cloneRecordwritePOST/crm/v8/{module}/{recordId}/actions/clone
singleInviteUseradmin, send, writePOST/crm/v8/{module}/{recordId}/actions/portal_invite
getEmailDraftsreadGET/crm/v8/{module}/{record}/__email_drafts
createEmailDraftswritePOST/crm/v8/{module}/{record}/__email_drafts
updateEmailDraftsForRecordwritePUT/crm/v8/{module}/{record}/__email_drafts
deleteEmailDraftsdeleteDELETE/crm/v8/{module}/{record}/__email_drafts/{draft}
getEmailDraftreadGET/crm/v8/{module}/{record}/__email_drafts/{draft}
updateEmailDraftswritePUT/crm/v8/{module}/{record}/__email_drafts/{draft}
assignTerritoriesToRecordwritePOST/crm/v8/{module}/{record}/actions/assign_territories
changeSingleRecordOwnersend, writePOST/crm/v8/{module}/{record}/actions/change_owner
removeTerritoriesFromRecordwritePOST/crm/v8/{module}/{record}/actions/remove_territories
deleteRecordPhotodeleteDELETE/crm/v8/{module}/{record}/photo
getRecordPhotoreadGET/crm/v8/{module}/{record}/photo
uploadRecordPhotowritePOST/crm/v8/{module}/{record}/photo
getDeletedRelatedRecordreadGET/crm/v8/{parentRecordModule}/deleted/{parentRecord}/{relatedList}
deleteBulkNotesdeleteDELETE/crm/v8/{parentRecordModule}/{parentRecordId}/Notes
getNotesreadGET/crm/v8/{parentRecordModule}/{parentRecordId}/Notes
createNoteswritePOST/crm/v8/{parentRecordModule}/{parentRecordId}/Notes
updateBulkNoteswritePUT/crm/v8/{parentRecordModule}/{parentRecordId}/Notes
deleteRelatedNoteByIddeleteDELETE/crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId}
getNotesByIdreadGET/crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId}
updateRelatedNoteByIdwritePUT/crm/v8/{parentRecordModule}/{parentRecordId}/Notes/{noteId}
delinkRelatedRecordsdeleteDELETE/crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}
getRelatedRecordsreadGET/crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}
updateRelatedRecordswritePUT/crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}
delinkSpecificRelatedRecorddeleteDELETE/crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record}
getRelatedRecordreadGET/crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record}
updateSpecificRelatedRecordwritePUT/crm/v8/{parentRecordModule}/{parentRecord}/{relatedList}/{record}

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.