Skip to content
SMBcrmSMBcrm Developers

Scopes

Scopes are the permissions attached to your token. Each endpoint requires one or more scopes; if your token doesn’t have the scope an endpoint needs, the request fails with 403 Forbidden. Grant the minimum scopes your integration actually uses.

  • Private Integration Tokens: you pick the scopes when you create the token.
  • OAuth: you request scopes during authorization, and the user approves them. See OAuth.

Most resources have a *.readonly scope for reading and a *.write scope for creating, updating, and deleting.

Contacts

Section titled “Contacts”
Scope Grants
contacts.readonly Read contacts, notes, and tasks
contacts.write Create/update/delete contacts, tags on contacts, notes, tasks, and workflow/campaign enrollment

Conversations & messages

Section titled “Conversations & messages”
Scope Grants
conversations.readonly Read conversations
conversations.write Create/update/delete conversations
conversations/message.readonly Read messages
conversations/message.write Send messages and record inbound messages

Calendars & appointments

Section titled “Calendars & appointments”
Scope Grants
calendars.readonly Read calendars and free slots
calendars.write Create/update/delete calendars
calendars/events.readonly Read appointments and events
calendars/events.write Book/update/delete appointments and events
calendars/groups.readonly / calendars/groups.write Read / manage calendar groups
calendars/resources.readonly / calendars/resources.write Read / manage bookable resources

Opportunities

Section titled “Opportunities”
Scope Grants
opportunities.readonly Read pipelines and opportunities
opportunities.write Create/update/delete opportunities and update status

Custom fields, values & tags

Section titled “Custom fields, values & tags”
Scope Grants
locations/customFields.readonly / locations/customFields.write Read / manage custom fields
locations/customValues.readonly / locations/customValues.write Read / manage custom values
locations/tags.readonly / locations/tags.write Read / manage tags

Your account/location

Section titled “Your account/location”
Scope Grants
locations.readonly Read your account/location details and timezones
locations/templates.readonly Read saved SMS/email templates
locations/tasks.readonly Read account-level tasks

Forms, funnels & surveys

Section titled “Forms, funnels & surveys”
Scope Grants
forms.readonly / forms.write Read forms and submissions / upload form files
funnels/redirect.readonly / funnels/redirect.write Read / manage funnel redirects
surveys.readonly Read surveys and submissions

Listing funnels and their pages only requires a valid token, with no additional scope.

Email

Section titled “Email”
Scope Grants
emails/templates.readonly / emails/templates.write Read / manage email templates
emails/campaigns.readonly / emails/campaigns.write Read / manage email campaigns
emails/stats.readonly Read email statistics

Workflows

Section titled “Workflows”
Scope Grants
workflows.readonly List workflows (enroll contacts via the contacts.write scope)

Blogs

Section titled “Blogs”
Scope Grants
blogs/list.readonly List blog sites
blogs/posts.readonly Read blog posts
blogs/post.write Create blog posts
blogs/post-update.write Update blog posts
blogs/author.readonly Read blog authors
blogs/category.readonly Read blog categories
blogs/check-slug.readonly Check whether a post slug is available

Social Planner

Section titled “Social Planner”
Scope Grants
socialplanner/account.readonly Read connected social accounts
socialplanner/post.readonly / socialplanner/post.write Read / manage social posts
socialplanner/category.readonly / socialplanner/category.write Read / manage categories
socialplanner/statistics.readonly Read post statistics
socialplanner/csv.write Bulk-upload posts by CSV

Products & payments

Section titled “Products & payments”
Scope Grants
products.readonly / products.write Read / manage products
products/prices.readonly / products/prices.write Read / manage product prices
products/collection.readonly / products/collection.write Read / manage product collections
payments/orders.readonly / payments/orders.write Read / manage orders
payments/orders.collectPayment Record a payment against an order
payments/transactions.readonly Read transactions
payments/subscriptions.readonly Read subscriptions
payments/coupons.readonly / payments/coupons.write Read / manage coupons

Invoices & estimates

Section titled “Invoices & estimates”
Scope Grants
invoices.readonly / invoices.write Read / create & send invoices
invoices/estimate.readonly / invoices/estimate.write Read / manage estimates
invoices/schedule.readonly / invoices/schedule.write Read / manage recurring invoice schedules
invoices/template.readonly / invoices/template.write Read / manage invoice templates