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

# Update Channel

> Update channel settings and metadata

Updates a channel's name, description, access controls, and other settings. Only the channel creator or admins can update channels.

## Authentication

Requires a valid user session. User must be the channel creator or an admin.

## Path Parameters

<ParamField path="id" type="string" required>
  The unique identifier of the channel to update
</ParamField>

## Request Body

<ParamField body="name" type="string" required>
  Channel name
</ParamField>

<ParamField body="description" type="string">
  Channel description
</ParamField>

<ParamField body="is_private" type="boolean">
  Whether the channel is private (for group channels)
</ParamField>

<ParamField body="data" type="object">
  Additional channel data
</ParamField>

<ParamField body="meta" type="object">
  Channel metadata
</ParamField>

<ParamField body="access_grants" type="array">
  Access control grants for the channel

  <Expandable title="Access Grant Object">
    <ParamField body="principal_type" type="string" required>
      Type of principal: `user`, `group`, or `role`
    </ParamField>

    <ParamField body="principal_id" type="string" required>
      ID of the principal, or `*` for public access
    </ParamField>

    <ParamField body="permission" type="string" required>
      Permission level: `read` or `write`
    </ParamField>
  </Expandable>
</ParamField>

<ParamField body="group_ids" type="array">
  Array of group IDs to grant access to the channel
</ParamField>

<ParamField body="user_ids" type="array">
  Array of user IDs to grant access to the channel
</ParamField>

## Response

Returns the updated channel object.

<ResponseField name="id" type="string" required>
  Unique channel identifier
</ResponseField>

<ResponseField name="user_id" type="string" required>
  ID of the user who created the channel
</ResponseField>

<ResponseField name="type" type="string">
  Channel type
</ResponseField>

<ResponseField name="name" type="string" required>
  Channel name
</ResponseField>

<ResponseField name="description" type="string">
  Channel description
</ResponseField>

<ResponseField name="is_private" type="boolean">
  Whether the channel is private
</ResponseField>

<ResponseField name="data" type="object">
  Additional channel data
</ResponseField>

<ResponseField name="meta" type="object">
  Channel metadata
</ResponseField>

<ResponseField name="access_grants" type="array">
  Updated access control grants
</ResponseField>

<ResponseField name="created_at" type="integer" required>
  Creation timestamp (epoch time in nanoseconds)
</ResponseField>

<ResponseField name="updated_at" type="integer" required>
  Updated timestamp (epoch time in nanoseconds)
</ResponseField>

<ResponseField name="updated_by" type="string">
  ID of user who updated the channel
</ResponseField>

<RequestExample>
  ```bash Update Name & Description theme={null}
  curl -X POST "https://your-domain.com/api/channels/ch_abc123/update" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "announcements-updated",
      "description": "Official company announcements"
    }'
  ```

  ```bash Update Access Grants theme={null}
  curl -X POST "https://your-domain.com/api/channels/ch_abc123/update" \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "general",
      "description": "General discussion",
      "access_grants": [
        {
          "principal_type": "user",
          "principal_id": "*",
          "permission": "read"
        },
        {
          "principal_type": "group",
          "principal_id": "group_moderators",
          "permission": "write"
        }
      ]
    }'
  ```

  ```python Python theme={null}
  import requests

  response = requests.post(
      "https://your-domain.com/api/channels/ch_abc123/update",
      headers={"Authorization": "Bearer YOUR_TOKEN"},
      json={
          "name": "engineering",
          "description": "Engineering team discussions",
          "is_private": True,
          "meta": {
              "slack_channel": "#engineering"
          }
      }
  )

  channel = response.json()
  print(f"Updated channel: {channel['name']}")
  ```
</RequestExample>

<ResponseExample>
  ```json 200 OK theme={null}
  {
    "id": "ch_abc123",
    "user_id": "user_123",
    "type": "standard",
    "name": "announcements-updated",
    "description": "Official company announcements",
    "is_private": false,
    "data": null,
    "meta": null,
    "access_grants": [
      {
        "principal_type": "user",
        "principal_id": "*",
        "permission": "read"
      },
      {
        "principal_type": "role",
        "principal_id": "admin",
        "permission": "write"
      }
    ],
    "created_at": 1709500000000000000,
    "updated_at": 1709567890123456789,
    "updated_by": "user_123",
    "archived_at": null,
    "archived_by": null,
    "deleted_at": null,
    "deleted_by": null
  }
  ```

  ```json 404 Not Found theme={null}
  {
    "detail": "Not found"
  }
  ```

  ```json 403 Forbidden theme={null}
  {
    "detail": "ERROR"
  }
  ```

  ```json 400 Bad Request theme={null}
  {
    "detail": "ERROR"
  }
  ```
</ResponseExample>

## Notes

* Only the channel creator (`user_id`) or admins can update channels
* All fields in the request body are optional, but at least the `name` field should be provided
* Updating access grants will replace the existing grants entirely
* The `updated_at` timestamp and `updated_by` field are automatically updated