Skip to content

API key scopes

Scopes follow {resource}.{action} with actions read, write, delete. The wildcards crm.read, crm.write and crm.delete grant the action on every resource. A key with no explicit scopes defaults to read-only (crm.read).

Every API-key request is checked twice: a baseline gate derives the required scope from the URL and HTTP method, and permissioned routes enforce their own explicit scope on top. Deletes always require the delete action; admin configuration requires admin.*.

Scope Grants
contacts.read View contacts
contacts.write Create and update contacts
contacts.delete Delete contacts
accounts.read View accounts
accounts.write Create and update accounts
accounts.delete Delete accounts
leads.read View leads
leads.write Create and update leads
leads.delete Delete leads
opportunities.read View opportunities and deals
opportunities.write Create and update opportunities
opportunities.delete Delete opportunities
campaigns.read View campaigns
campaigns.write Create and update campaigns
campaigns.delete Delete campaigns
conversations.read View calls, meetings, and notes
conversations.write Log calls, meetings, and notes
conversations.delete Delete conversation records
forecasts.read View revenue forecasts
forecasts.write Update forecast submissions
forecasts.delete Delete forecast records
analytics.read View analytics and reports
analytics.write Create and update reports
analytics.delete Delete reports
pipeline.read View pipeline stages and configuration
pipeline.write Update pipeline configuration
pipeline.delete Delete pipeline stages
products.read View product catalog
products.write Update product catalog
products.delete Delete products
support.read View support tickets and conversations
support.write Create and update support tickets
support.delete Delete support tickets
webhooks.read View webhook endpoints
webhooks.write Create and update webhooks
webhooks.delete Delete webhooks
quotes.read View quotes and CPQ deals
quotes.write Create and update quotes
quotes.delete Delete quotes
orders.read View orders
orders.write Create and update orders
orders.delete Delete orders
contracts.read View contracts
contracts.write Create, update and send contracts
contracts.delete Delete contracts
invoices.read View invoices
invoices.write Create, send and record payment on invoices
invoices.delete Void invoices
renewals.read View renewals
renewals.write Create and update renewals
renewals.delete Delete renewals
revenue.read View revenue schedules and recognition
revenue.write Update revenue schedules
revenue.delete Delete revenue schedules
cadences.read View cadences and enrollments
cadences.write Create cadences and enroll leads
cadences.delete Delete cadences
tasks.read View tasks, CTAs and playbooks
tasks.write Create and update tasks and CTAs
tasks.delete Delete tasks and CTAs
customers.read View customer success data (health, churn, plans)
customers.write Update customer success records
customers.delete Delete customer success records
enablement.read View enablement content, learning and readiness
enablement.write Create and update enablement content
enablement.delete Delete enablement content
compensation.read View compensation plans, earnings and statements
compensation.write Update compensation records
compensation.delete Delete compensation records
rfp.read View RFx projects and the content library
rfp.write Create and update RFx projects and answers
rfp.delete Delete RFx projects
surveys.read View surveys and responses
surveys.write Create and distribute surveys
surveys.delete Delete surveys
knowledge_base.read View knowledge base articles
knowledge_base.write Create and update knowledge base articles
knowledge_base.delete Delete knowledge base articles
emails.read View synced email and templates
emails.write Create email templates and send email
emails.delete Delete email records
usage.read View product usage and entitlements
usage.write Ingest usage events and update meters
usage.delete Delete usage records
segments.read View marketing segments
segments.write Create and update segments
segments.delete Delete segments
custom_objects.read View custom objects and records
custom_objects.write Create and update custom objects and records
custom_objects.delete Delete custom objects and records
workflows.read View workflows and process agents
workflows.write Create, update and trigger workflows
workflows.delete Delete workflows
agents.read View AI agents and their runs
agents.write Create, update and run AI agents
agents.delete Delete AI agents
users.read View users, teams and org structure
users.write Create and update users and teams
users.delete Deactivate users
integrations.read View integrations and connectors
integrations.write Configure integrations and run imports
integrations.delete Remove integrations
website.read View website pages, forms and tracking
website.write Update website pages and forms
website.delete Delete website pages
reports.read View and run reports
reports.write Create and update reports
reports.delete Delete reports
ai.read View AI configuration and activity
ai.write Use AI features (Ask, drafting, config)
ai.delete Delete AI configuration
admin.read View admin configuration (roles, fields, settings)
admin.write Change admin configuration
admin.delete Delete admin configuration
crm.read Read all CRM data
crm.write Write all CRM data
crm.delete Delete any CRM data