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

# Update an embed group

**🔒 Admin only.** Requires administrator privileges — the authenticated principal (API key, embed JWT, or any bearer token) must belong to a user with the admin role.

Updates a group’s description. The name is deliberately immutable: it is part of the security context an embed session carries (`system:tenant:{embedTenantName}:{name}`), so renaming would silently detach the data-model access policies written against it — create a new group instead. Pass an empty `description` to clear it.


## OpenAPI

````yaml /api-reference/api.yaml patch /api/v1/embed-tenants/{embedTenantName}/groups/{id}
openapi: 3.1.0
info:
  title: Cube Platform API
  version: 1.0.0
  description: >-
    Programmatically manage Cube: deployments and everything scoped to them

    (environments, folders, reports, workbooks, notifications, workspace, and
    agents),

    plus account-level users, groups, policies, embedding, and AI settings.
    Data-model

    authoring, dev mode, branches, and uploads live under /build/api/v1 — same
    host and

    token, routed to the build pods.
servers:
  - url: https://{tenant}.cubecloud.dev
    description: Your tenant host. Replace the whole host if you use a custom domain.
    variables:
      tenant:
        default: your-tenant
        description: Your Cube tenant subdomain
security:
  - bearerAuth: []
tags:
  - name: Deployments
  - name: Deployment Creation
  - name: Environments
  - name: Env Variables
  - name: Regions
  - name: Data Model
  - name: Data Model Uploads
  - name: GitHub
  - name: GitHub Connection
  - name: dbt Sync
  - name: Folders
  - name: Reports
  - name: Workbooks
  - name: Notifications
  - name: Workspace
  - name: Users Admin
  - name: User Attributes
  - name: User Attribute Values
  - name: Tenant Settings
  - name: OAuth Integrations
  - name: User OAuth Tokens
  - name: OIDC Token Configs
  - name: App Theme
  - name: Embed
  - name: Embed Tenants
  - name: Dashboard Embed Access
paths:
  /api/v1/embed-tenants/{embedTenantName}/groups/{id}:
    patch:
      tags:
        - Embed Tenants
      summary: Update an embed group
      operationId: updateGroup
      parameters:
        - in: path
          name: embedTenantName
          required: true
          schema:
            type: string
          description: >-
            Name of the embed tenant (the `embedTenantName` used to generate
            embed sessions).
        - in: path
          name: id
          required: true
          schema:
            type: integer
          description: Numeric id of the group, as returned by the groups endpoints.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEmbedGroupInput'
        description: UpdateEmbedGroupInput
        required: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserGroupDTO'
          description: ''
components:
  schemas:
    UpdateEmbedGroupInput:
      properties:
        description:
          oneOf:
            - maxLength: 500
              type: string
              description: >-
                New description. Pass an empty string to clear it. Omit to leave
                it unchanged.
            - type: 'null'
      type: object
    UserGroupDTO:
      properties:
        description:
          oneOf:
            - type: string
            - type: 'null'
        id:
          type: integer
        name:
          type: string
        userCount:
          oneOf:
            - type: integer
            - type: 'null'
      required:
        - id
        - name
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Token authentication. Send `Authorization: Bearer <YOUR_TOKEN>`.'

````