> ## Documentation Index
> Fetch the complete documentation index at: https://docs.suprsend.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Workspace Config

> Update one or more workspace-level configuration flags. Any field returned by `GET /v1/workspace/{workspace_slug}/config/` can be sent in the PATCH body — only fields you include are changed.




## OpenAPI

````yaml PATCH /v1/workspace/{workspace_slug}/config/
openapi: 3.1.1
info:
  title: SuprSend API
  description: APIs supported on suprsend platform
  version: 1.2.2
servers:
  - url: https://hub.suprsend.com
security:
  - sec0: []
  - BearerAuth: []
paths:
  /v1/workspace/{workspace_slug}/config/:
    patch:
      summary: Update Workspace Config
      description: >
        Update one or more workspace-level configuration flags. Any field
        returned by `GET /v1/workspace/{workspace_slug}/config/` can be sent in
        the PATCH body — only fields you include are changed.
      operationId: update-workspace-config
      parameters:
        - in: path
          name: workspace_slug
          required: true
          schema:
            type: string
          description: Workspace slug (e.g. `staging`, `production`).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceConfigUpdateRequest'
            example:
              user_tenancy_mode: shared
      responses:
        '202':
          description: Workspace config updated. The full updated config is returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceConfig'
              example:
                user_inbox_preference_enabled: true
                sms_vendor_type: basic
                user_tenancy_mode: shared
                user_tenancy_channel_fallback_mode: allowlist
                user_tenancy_channel_fallback:
                  - email
                  - sms
                  - whatsapp
                user_tenancy_channel_fallback_applies_to_default_tenant: false
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/AuthenticationError'
        '404':
          $ref: '#/components/responses/NotFoundError'
      security:
        - ServiceTokenAuth: []
      servers:
        - url: https://management-api.suprsend.com
      x-codeSamples:
        - lang: cURL
          label: Update Workspace Config
          source: >
            curl -X PATCH
            "https://management-api.suprsend.com/v1/workspace/{workspace_slug}/config/"
            \
              --header 'Authorization: ServiceToken <SERVICE_TOKEN>' \
              --header 'Content-Type: application/json' \
              --data '{"user_tenancy_mode":"shared"}'
components:
  schemas:
    WorkspaceConfigUpdateRequest:
      type: object
      description: >
        Body for `PATCH /v1/workspace/{workspace_slug}/config/`. Include only
        the fields you want to change — omitted fields are left untouched.
      properties:
        user_inbox_preference_enabled:
          type: boolean
          description: >-
            If you are using the Inbox channel, enable this to show the Inbox
            channel in the preference centre.
          example: true
        sms_vendor_type:
          type: string
          enum:
            - basic
            - dlt
          description: >-
            Switch the workspace's SMS delivery mode. Confirm with your SMS
            provider before switching to or from `dlt`.
          example: basic
        user_tenancy_mode:
          type: string
          enum:
            - shared
            - exclusive
          description: >
            Change how users are constrained across tenants. See [User-tenant
            mapping](/docs/user-tenant-mapping) for the effects of switching
            this value.


            Only `exclusive` → `shared` can be changed through the API.
            Switching from `shared` to `exclusive` returns `400`; contact
            support for that change.
          example: shared
        user_tenancy_channel_fallback_mode:
          type: string
          enum:
            - all
            - allowlist
          description: >-
            Switch between `all` (every channel falls back from global) and
            `allowlist` (only channels in `user_tenancy_channel_fallback` fall
            back).
          example: allowlist
        user_tenancy_channel_fallback:
          type: array
          items:
            type: string
          description: >-
            Channel keys (without the `$` prefix) allowed to fall back when
            `user_tenancy_channel_fallback_mode = allowlist`. Ignored otherwise.
            Inbox always falls back.
          example:
            - email
            - sms
            - whatsapp
        user_tenancy_channel_fallback_applies_to_default_tenant:
          type: boolean
          description: >-
            When true, the fallback rule above also governs sends with no
            `tenant_id`.
          example: false
    WorkspaceConfig:
      type: object
      description: Workspace-level configuration flags.
      properties:
        user_inbox_preference_enabled:
          type: boolean
          description: >-
            If you are using the Inbox channel, enable this to show the Inbox
            channel in the preference centre.
          example: true
        sms_vendor_type:
          type: string
          enum:
            - basic
            - dlt
          description: >-
            SMS delivery mode for the workspace. Use `dlt` for India
            DLT-compliant sends; `basic` for standard sends.
          example: basic
        user_tenancy_mode:
          type: string
          enum:
            - shared
            - exclusive
          description: >
            Constraint on user-tenant associations for this workspace.

            - `shared` — a user can belong to any number of tenants.

            - `exclusive` — a user can belong to at most one tenant. The
            associate call rejects users that already have a mapping.


            New workspaces default to `exclusive`; workspaces that existed
            before this setting was introduced default to `shared`.
          example: exclusive
        user_tenancy_channel_fallback_mode:
          type: string
          enum:
            - all
            - allowlist
          description: >
            Controls which channels a tenant-scoped profile is allowed to
            inherit from the user's global profile when the tenant has no
            override for that channel.

            - `all` — every channel falls back to global (default; reproduces a
            straight shallow merge).

            - `allowlist` — only the channels listed in
            `user_tenancy_channel_fallback` fall back; every other channel is
            dropped from the send when the tenant has no override for it.
            Prevents identities like `$androidpush` or `$slack` from leaking
            across tenants.
          example: all
        user_tenancy_channel_fallback:
          type: array
          items:
            type: string
          description: >
            Channel keys allowed to fall back from the global profile when
            `user_tenancy_channel_fallback_mode = allowlist`. Ignored when the
            mode is `all`. Values are channel names without the `$` prefix
            (`email`, `sms`, `whatsapp`, `androidpush`, `iospush`, `webpush`,
            `slack`, `ms_teams`). Inbox always falls back and cannot be listed.


            Typical setup: `["email", "sms", "whatsapp"]` — safe to fall back —
            while excluding `androidpush`, `iospush`, `webpush`, and `slack`.
          example:
            - email
            - sms
            - whatsapp
        user_tenancy_channel_fallback_applies_to_default_tenant:
          type: boolean
          default: false
          description: >
            Whether the fallback rule above also governs sends that carry no
            `tenant_id` (the default-tenant path).

            - `false` (default) — the default-tenant path always falls back for
            every channel, regardless of the allowlist.

            - `true` — the default-tenant path follows the same
            `user_tenancy_channel_fallback_mode` +
            `user_tenancy_channel_fallback` rule as other tenants.
          example: false
    ErrorResponse:
      type: object
      properties:
        code:
          type: integer
          description: HTTP status code
        error_code:
          type: string
          description: Specific error code identifier
        type:
          type: string
          description: Error type classification
        message:
          type: string
          description: Human-readable error message
        detail:
          oneOf:
            - type: string
            - type: object
            - type: array
              items:
                type: string
          description: >-
            Additional error details. A string for most errors. For validation
            errors, either an object mapping field names to their error
            messages, or an array of messages when the error is not tied to a
            field.
  responses:
    ValidationError:
      description: Validation error - data validation failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    AuthenticationError:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 401
            error_code: authentication_failed
            type: AuthenticationFailed
            message: Invalid service token.
            detail: Invalid service token.
    NotFoundError:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          example:
            code: 404
            error_code: not_found
            type: NotFound
            message: workspace 'demo' not found
            detail: workspace 'demo' not found
  securitySchemes:
    sec0:
      type: apiKey
      in: header
      name: Authorization
      x-bearer-format: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where <token>
        is your auth token.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API_Key
      description: >-
        Pass as `Bearer <API_KEY>`. Get API Key from SuprSend dashboard
        Developers -> API Keys section.
    ServiceTokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Pass as `Authorization: ServiceToken <token>`. You can get Service Token
        from [SuprSend dashboard -> Account Settings -> Service
        Tokens](https://app.suprsend.com/en/account-settings/service-tokens)
        section.

````

## Related topics

- [Get Workspace Config](https://docs.suprsend.com/reference/get-workspace-config.md)
- [Product Updates](https://docs.suprsend.com/changelog/overview.md)
- [Workspaces](https://docs.suprsend.com/docs/workspaces.md)
- [MCP Changelog](https://docs.suprsend.com/reference/mcp-changelog.md)
- [Designing Notifications for B2B2C Applications](https://docs.suprsend.com/docs/guides/modelling-customers-b2b2c.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.