diff options
| author | Owen Jacobson <owen@grimoire.ca> | 2024-10-30 01:07:12 -0400 |
|---|---|---|
| committer | Owen Jacobson <owen@grimoire.ca> | 2024-10-30 01:07:12 -0400 |
| commit | 36e659e971d091cfcbe370f5e45a0d01102d2e83 (patch) | |
| tree | b820f037590d9923ef8cbe8d8a2a9d73b4ed1be6 /docs/api | |
| parent | 2bac295504960ac4a18d7c19513160363f587f01 (diff) | |
Prevent deletion of non-empty channels.
Diffstat (limited to 'docs/api')
| -rw-r--r-- | docs/api/channels-messages.md | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/docs/api/channels-messages.md b/docs/api/channels-messages.md index d87a01c..2aa8ac5 100644 --- a/docs/api/channels-messages.md +++ b/docs/api/channels-messages.md @@ -164,7 +164,7 @@ This endpoint will respond with a status of `404 Not Found` if the channel ID is Deletes a channel. -Deleting a channel prevents it from receiving any further messages, and deletes the messages it contains at that point. +Deleting a channel prevents it from receiving any further messages. The channel must be empty; to delete a channel with messages in it, delete the messages first (or wait for them to expire). This endpoint requires the following path parameter: @@ -190,6 +190,9 @@ The response will have the following fields: When completed, the service will emit a [message deleted](events.md#message-deleted) event for each message in the channel, followed by a [channel deleted](events.md#channel-deleted) event with the channel's ID. +### Channel not empty + +This endpoint will respond with a status of `409 Conflict` if the channel contains messages. ### Invalid channel ID |