communicate-so Account preferences API

openapi: 3.2.0
info:
  title: Communicate So Account preferences API
  version: 0.1.5
  description: 'Operations tagged Account preferences across 2 of this provider''s published API definitions: communicate-so-openapi.json, communicate-so-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.communicate.so/api/v1
  description: Canonical external base URL served through the Next.js /api/v1 rewrite.
security:
- oauth2: []
- bearerAuth: []
tags:
- name: Account preferences
paths:
  /account/preferences:
    get:
      operationId: getAccountPreferences
      summary: Read preferences that follow the authenticated user across workspaces
      tags:
      - Account preferences
      description: Use a user-bound `ca_` bearer credential with the stated account scope, or an application session. Workspace `ck_` keys and their OAuth tokens do not grant account authority.
      security:
      - accountBearer: []
      - accountSession: []
      - localAccountSession: []
      x-required-account-scopes:
      - inbox:read
      responses:
        '200':
          description: Read preferences that follow the authenticated user across workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPreferences'
          headers:
            Cache-Control:
              schema:
                type: string
                const: no-store
        '401':
          description: Session or credential missing, invalid, expired or revoked; fresh password proof failed when required.
        '403':
          description: Email verification, trusted origin or required account scope is missing.
        '429':
          description: Per-user list or password proof rate limit exceeded.
        '500':
          description: Unexpected server failure.
    patch:
      operationId: updateAccountPreferences
      summary: Save preferences that follow the authenticated user across workspaces
      tags:
      - Account preferences
      description: Use a user-bound `ca_` bearer credential with the stated account scope, or an application session. Workspace `ck_` keys and their OAuth tokens do not grant account authority.
      security:
      - accountBearer: []
      - accountSession: []
      - localAccountSession: []
      x-required-account-scopes:
      - inbox:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AccountPreferences'
      responses:
        '200':
          description: Save preferences that follow the authenticated user across workspaces
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountPreferences'
          headers:
            Cache-Control:
              schema:
                type: string
                const: no-store
        '400':
          description: Invalid request body or pagination.
        '401':
          description: Session or credential missing, invalid, expired or revoked; fresh password proof failed when required.
        '403':
          description: Email verification, trusted origin or required account scope is missing.
        '429':
          description: Per-user list or password proof rate limit exceeded.
        '500':
          description: Unexpected server failure.
    servers:
    - url: https://app.communicate.so/api/v1
      description: Canonical external base URL served through the Next.js /api/v1 rewrite.
components:
  schemas:
    AccountPreferences:
      type: object
      properties:
        inboxView:
          type: string
          enum:
          - chat
          - ticket
      required:
      - inboxView
      additionalProperties: false
  securitySchemes:
    accountSession:
      type: apiKey
      in: cookie
      name: __Secure-better-auth.session_token
      description: Signed Better Auth session cookie for an HTTPS application origin. Credential management additionally requires verified email and fresh password proof on writes.
    localAccountSession:
      type: apiKey
      in: cookie
      name: better-auth.session_token
      description: Signed session cookie used when the configured application auth origin is HTTP, such as local development.
    accountBearer:
      type: http
      scheme: bearer
      bearerFormat: Account credential
      description: Opaque user-bound `ca_` account credential. Each request checks live account scopes, verified email, expiry, revocation and the issuer session. Not a workspace `ck_` key or OAuth access token.
    clientCredentialsBasic:
      type: http
      scheme: basic
      description: Use the API key ID as the username and the one-time `ck_` API key token as the password.
    oauth2:
      type: oauth2
      description: OAuth 2.0 client-credentials tokens bounded by the source API key scope ceiling.
      flows:
        clientCredentials:
          tokenUrl: https://app.communicate.so/api/v1/oauth/token
          scopes:
            agents:read: List agents in the authenticated workspace.
            chat:write: Create chat turns with an agent in the authenticated workspace.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: Workspace API key token with the `ck_` prefix.
x-refined-from:
- communicate-so-openapi.json
- communicate-so-openapi.json