Home

Integrations

Interactive bots (beta)

REST API

Messages

Streams

Users

Server & organizations

Real-time events

Specialty endpoints

Back to Zulip

Update a message

Edit/update the content or topic of a message.

PATCH https://chat.zymocosm.com/api/v1/messages/{msg_id}

{msg_id} in the above URL should be replaced with the ID of the message you wish you update.

Usage examples

  • Python
  • JavaScript
  • curl

#!/usr/bin/env python3

import zulip

# Pass the path to your zuliprc file here.
client = zulip.Client(config_file="~/zuliprc")

# Edit a message
# (make sure that message_id below is set to the ID of the
# message you wish to update)
request = {
    "message_id": message_id,
    "content": "New content"
}
result = client.update_message(request)
print(result)

More examples and documentation can be found here.

const zulip = require('zulip-js');

// Pass the path to your zuliprc file here.
const config = {
    zuliprc: 'zuliprc',
};

zulip(config).then((client) => {
    // Update a message
    const params = {
        message_id: 131,
        content: 'New Content',
    }

    client.messages.update(params).then(console.log);
});


curl -sSX PATCH https://chat.zymocosm.com/api/v1/messages/42 \
    -u BOT_EMAIL_ADDRESS:BOT_API_KEY \
    -d 'topic=Castle' \
    -d 'propagate_mode=change_all' \
    -d 'content=Hello'

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.

Arguments

Argument Example Required Description
message_id 42 Yes

The ID of the message that you wish to edit/update.
topic "Castle" No

The topic of the message. Only required for stream messages. Maximum length of 60 characters.
propagate_mode "change_all" No

Which message(s) should be edited: just the one indicated in message_id, messages in the same topic that had been sent after this one, or all of them. Must be one of: change_one, change_later, change_all. Defaults to "change_one".
content "Hello" No

The content of the message. Maximum message size of 10000 bytes.

Response

Example response

A typical successful JSON response may look like:

{
    "msg": "",
    "result": "success"
}

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

{
    "code": "BAD_REQUEST",
    "msg": "You don't have permission to edit this message",
    "result": "error"
}