sendmux-ai OAuth Scopes

generated: '2026-10-31'
method: derived
source: openapi/openapi-app.json
schemes:
- name: oauth2
  source: openapi/openapi-app.json
  flows:
  - flow: authorizationCode
    authorizationUrl: https://app.sendmux.ai/oauth/authorize
    tokenUrl: https://app.sendmux.ai/oauth/token
  description: Use the authorisation-code flow with S256 PKCE and resource=https://sendmux.ai/api.
    The user selects the team, API access and mailboxes during consent. OAuth access tokens
    authenticate HTTP API requests; use separate credentials for SMTP and IMAP.
scopes:
- scope: analytics.*
  description: All analytics operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: analytics.read
  description: View key usage analytics and verification logs
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: billing.*
  description: All billing operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: billing.auto_topup
  description: Configure auto top-up settings
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: billing.read
  description: View balance, transactions, invoices
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: billing.topup
  description: Purchase balance top-ups
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: calendar.read
  description: Read calendars and events in this mailbox
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: calendar.write
  description: Create calendars and create, edit and delete events in this mailbox
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: domain.*
  description: All domain operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: domain.create
  description: Add sending domains
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: domain.delete
  description: Remove domains
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: domain.read
  description: List/view domains and DNS status
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: domain.verify
  description: Trigger domain verification
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: email.receive
  description: Authorise email reception
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: email.send
  description: Send email through the HTTP API
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: key.*
  description: All key management operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: key.create
  description: Create new API keys (both root and mailbox)
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: key.read
  description: List/view API keys and their metadata
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: key.revoke
  description: Revoke API keys
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: key.rotate
  description: Rotate API keys
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: logs.*
  description: All log operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: logs.read
  description: View delivery logs
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: mailbox.admin.*
  description: All mailbox admin operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: mailbox.admin.create
  description: Create mailboxes (admin-level)
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: mailbox.admin.delete
  description: Delete mailboxes (admin-level)
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: mailbox.admin.manage
  description: Manage all mailbox settings
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: mailbox.admin.read
  description: List/view mailboxes (admin-level)
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: mailbox.drafts.write
  description: Create and edit saved mailbox drafts
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: mailbox.read
  description: Read mailbox contents (folders, messages)
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: mailbox.settings.update
  description: Update own mailbox settings (signature, auto-reply)
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: provider.*
  description: All provider operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: provider.create
  description: Add email provider accounts (Google, Microsoft, SMTP)
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: provider.delete
  description: Remove provider accounts
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: provider.read
  description: List/view provider accounts and connection status
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: provider.update
  description: Update provider settings, refresh tokens
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: routing.*
  description: All routing operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: routing.create
  description: Create delivery groups
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: routing.delete
  description: Remove delivery groups
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: routing.read
  description: List/view delivery groups and routing rules
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: routing.update
  description: Update delivery group configuration
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: team.*
  description: All team operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: team.members.invite
  description: Invite team members
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: team.members.remove
  description: Remove team members
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: team.members.roles
  description: Change member roles
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: team.read
  description: View team settings and members
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: team.update
  description: Update team settings
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: webhook.*
  description: All webhook operations
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: webhook.create
  description: Create webhook subscriptions
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: webhook.delete
  description: Delete webhook subscriptions
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: webhook.manage
  description: Rotate signing secret + send test events
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: webhook.read
  description: List/view webhook subscriptions
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json
- scope: webhook.update
  description: Update webhook URL, event types, enabled flag
  flows:
  - authorizationCode
  sources:
  - openapi/openapi-app.json