CodeCow/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2026-06-24 21:08:25 +08:00
Code Issues Actions 6 Packages Projects Releases Wiki Activity
93101c953f
zulip/templates/zerver/api/update-message.md
Sumanth V Rao 3e80cbdeb8 docs/update-message: Add missing editing permission condition. 
The comments within update_message_backend function of views/message_edit.py
indicates 4 types of permissions which all edit a message. The 4th of these
indicates that a message is editable if the realm allows topic edits. This
was previously missing from the docs and is now added.
2020-07-27 16:33:36 -07:00

1.1 KiB
Raw Blame History

Edit a message

{generate_api_description(/messages/{message_id}:patch)}

Usage examples

{start_tabs} {tab|python}

{generate_code_example(python)|/messages/{message_id}:patch|example}

{tab|js}

More examples and documentation can be found here.

{generate_code_example(javascript)|/messages/{message_id}:patch|example}

{tab|curl}

{generate_code_example(curl, exclude=["stream_id"])|/messages/{message_id}:patch|example}

{end_tabs}

Permissions

You only have permission to edit a message if:

  1. You sent it, OR:
  2. This is a topic-only edit for a (no topic) message, OR:
  3. This is a topic-only edit and you are an admin, OR:
  4. This is a topic-only edit and your realm allows users to edit topics.

Parameters

{generate_api_arguments_table|zulip.yaml|/messages/{message_id}:patch}

Response

Example response

A typical successful JSON response may look like:

{generate_code_example|/messages/{message_id}:patch|fixture(200)}

A typical JSON response for when one doesn't have the permission to edit a particular message:

{generate_code_example|/messages/{message_id}:patch|fixture(400)}