zulip/templates/zerver/api/delete-message.md

40 lines
952 B
Markdown

# Delete a message
{generate_api_description(/messages/{message_id}:delete)}
[delete-completely]: /help/edit-or-delete-a-message#delete-a-message-completely
## Usage examples
{start_tabs}
{tab|python}
{generate_code_example(python)|/messages/{message_id}:delete|example(admin_config=True)}
{tab|curl}
{generate_code_example(curl)|/messages/{message_id}:delete|example}
{end_tabs}
## Arguments
{generate_api_arguments_table|zulip.yaml|/messages/{message_id}:delete}
## Response
#### Example response
A typical successful JSON response may look like:
{generate_code_example|/messages/{message_id}:delete|fixture(200)}
An example JSON response for when the specified message does not exist:
{generate_code_example|/messages/{message_id}:delete|fixture(400_0)}
An example JSON response for when the user making the query does not
have permission to delete the message:
{generate_code_example|/messages/{message_id}:delete|fixture(400_1)}