GEgetstream
product:chat

Deletes channels asynchronously

Changed on

Allows to delete several channels at once asynchronously

Sends events:

  • channel.deleted
post/channels/delete

Request

  • Base URL
    https://chat.stream-io-api.com
  • URL
    https://chat.stream-io-api.com/channels/delete
  • 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

Request body

cidsstring[] required

All channels that should be deleted

hard_deleteboolean

Server-side only. When true, the channels and all their 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 any of these channel IDs restores the full history. Only supported for distinct channels. Cannot be combined with hard_delete.

Response

Successful response

durationstring required

Duration of the request in milliseconds

resultobject

Map of channel IDs and their deletion results

task_idstring

Changes

  • 30f95dce0284Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 0467a5d8654fRevision changes
    • info

      added the new optional request property