updateChatChannel

Requires an authenticated session.

Changes a channel's name or description. Only an admin or manager, or an admin of that channel, can do this. Needs a signed-in user.

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

mutation UpdateChatChannel($id: String!, $input: UpdateChannelInput!) {
  updateChatChannel(id: $id, input: $input) {
    id
    name
    createdAt
    createdBy
    description
    isDefault
    conversation {
      id
      title
      type
      createdAt
      channelId
      isGroup
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation UpdateChatChannel($id: String!, $input: UpdateChannelInput!) {\n  updateChatChannel(id: $id, input: $input) {\n    id\n    name\n    createdAt\n    createdBy\n    description\n    isDefault\n    conversation {\n      id\n      title\n      type\n      createdAt\n      channelId\n      isGroup\n    }\n  }\n}",
  "variables": {
    "id": "string",
    "input": {}
  }
}
EOF

Variables:

{
  "id": "string",
  "input": {}
}

Response:

{
  "data": {
    "updateChatChannel": {
      "id": "id",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "createdBy": "string",
      "description": "string",
      "isDefault": true,
      "conversation": {
        "id": "id",
        "title": "string",
        "type": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "channelId": "string",
        "isGroup": true
      }
    }
  }
}

updateChatChannel(
  id: String!
  input: UpdateChannelInput!
): ChatChannel!

Arguments

updateChatChannel.id ● String! non-null scalar

The ID of the chat channel.

updateChatChannel.input ● UpdateChannelInput! non-null input

The name or description to change.

Type

ChatChannel object

A chat channel that people can join.