From 98af8ff80da919a1126ba7c6afa65e6654b5ecde Mon Sep 17 00:00:00 2001 From: Owen Jacobson Date: Sat, 19 Oct 2024 01:02:50 -0400 Subject: Mention the message deleted events, and that deleted channels cannot receive messages. --- docs/api/channels-messages.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) (limited to 'docs/api/channels-messages.md') diff --git a/docs/api/channels-messages.md b/docs/api/channels-messages.md index 69cadcb..1ff037d 100644 --- a/docs/api/channels-messages.md +++ b/docs/api/channels-messages.md @@ -134,7 +134,9 @@ This endpoint will respond with a status of `404 Not Found` if the channel ID is ## `DELETE /api/channels/:id` -Deletes a channel (and all messages in it). +Deletes a channel. + +Deleting a channel prevents it from receiving any further messages, and deletes the messages it contains at that point. This endpoint requires the following path parameter: @@ -146,7 +148,7 @@ This endpoint requires the following path parameter: This endpoint will respond with a status of `202 Accepted` when successful. The response will not include a body. -When completed, the service will emit a [channel deleted](events.md#channel-deleted) event with the channel's ID. +When completed, the service will emit a [channel deleted](events.md#channel-deleted) event with the channel's ID. In addition, the service will emit a [message deleted](events.md#message-deleted) event for each message deleted. ### Invalid channel ID -- cgit v1.2.3