GEgetstream
product:chat

Delete channel

Changed on

Deletes channel

Sends events:

  • channel.deleted
delete/channels/{type}/{id}

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/channels/{type}/{id}
  • Auth
    • API key in header Authorization and API key in query parameter api_key and API key in header Stream-Auth-Type
    • or API key in query parameter api_key and API key in header Stream-Auth-Type

Path parameters

typestring required

Channel type to interact with

idstring required

Channel ID to interact with

Query parameters

hard_deleteboolean

Server-side only. When true, the channel and all its resources are permanently deleted instead of soft-deleted.

skip_truncateboolean

Server-side only. When true, the soft delete preserves message history instead of hiding it, so a later recreation of the same channel ID restores the full history. Only supported for distinct channels. Cannot be combined with hard_delete.

Response

Response

durationstring required

Duration of the request in milliseconds

Example response

{
  "channel": {
    "config": {
      "partition_ttl": "24h"
    }
  }
}

Changes

  • 00df5052235bRevision changes
    • info

      added the optional property // to the response with the status

  • 8acf79c23a74Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status