DELETE /messages/{message_id}
Permanently delete a message.
This API corresponds to the delete a message completely feature documented in the Zulip help center.
A user must be able to access the content of a message in order to delete it. See channel permissions for more information about content access for channel messages. For direct messages, the user must have received or sent the direct message to have content access.
See restricting message deletion for documentation on when users are allowed to delete messages.
The relevant realm settings in the API that are related to the above linked documentation on when users are allowed to delete messages are:
realm_can_delete_any_message_grouprealm_can_delete_own_message_grouprealm_can_set_delete_message_policy_grouprealm_message_content_delete_limit_seconds
The relevant per-channel permission settings in the API that are related to the above linked documentation on when users are allowed to delete messages in a specific channel are:
can_delete_any_message_groupcan_delete_own_message_group
More details about these realm and channel settings can be found in the
POST /register response.
Changes: Prior to Zulip 10.0 (feature level 281), only organization administrators had permission to permanently delete a message.
Servers
- https://{subdomain}.zulipchat.com/api/v1
- {server}/api/v1
- https://chat.zulip.org/api/v1
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
message_id |
Integer | Yes |
The target message's ID. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.