deleteChatChannel

Requires an authenticated session.

Deletes a channel together with its conversation and messages. The default channel cannot be deleted. Only an admin or manager, or the channel's creator, 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 DeleteChatChannel($id: String!) {
  deleteChatChannel(id: $id) {
    message
    success
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "mutation DeleteChatChannel($id: String!) {\n  deleteChatChannel(id: $id) {\n    message\n    success\n  }\n}",
  "variables": {
    "id": "string"
  }
}
EOF

Variables:

{
  "id": "string"
}

Response:

{
  "data": {
    "deleteChatChannel": {
      "message": "string",
      "success": true
    }
  }
}

deleteChatChannel(
  id: String!
): DeleteResponse!

Arguments

deleteChatChannel.id ● String! non-null scalar

The ID of the chat channel.

Type

DeleteResponse object

The result of a mutation that deletes a record and has nothing left to return.