You must enable javascript in order to use the Slack API Documentation. You can do this in your browser settings.
Go to Slack

chat.update

You're not signed into any teams. Sign in to test authentication.

Supported token types:

This method updates a message in a channel. Though related to chat.postMessage, some parameters of chat.update are handled differently.

Ephemeral messages created by chat.postEphemeral or otherwise cannot be updated with this method.

Arguments

This method has the URL https://slack.com/api/chat.update and follows the Slack Web API calling conventions.

Argument Example Required Description
token xxxx-xxxxxxxxx-xxxx Required

Authentication token bearing required scopes.

channel C1234567890 Required

Channel containing the message to be updated.

text Hello world Required

New text for the message, using the default formatting rules. It's not required when presenting attachments.

ts 1405894322.002768 Required

Timestamp of the message to be updated.

as_user true Optional

Pass true to update the message as the authed user. Bot users in this context are considered authed users.

attachments [{"pretext": "pre-hello", "text": "text-world"}] Optional

A JSON-based array of structured attachments, presented as a URL-encoded string. This field is required when not presenting text.

link_names true Optional

Find and link channel names and usernames. Defaults to none. This parameter should be used in conjunction with parse. To set link_names to 1, specify a parse mode of full.

parse none Optional

Change how messages are treated. Defaults to client, unlike chat.postMessage. See below.

This method supports application/json via HTTP POST. Present your token in your request's Authorization header. Learn more.

Formatting

The default value for parse will attempt to discover links in text but does not support URL markup. To update messages with URL markup, you must specify parse=none. For more information, refer to the formatting spec.

To use link_names, you'll need to explicitly set the parse parameter to full.

The optional attachments argument should contain a JSON-encoded array of attachments. If you do not include an attachments property, a message's previous attachments will remain visible. To remove a previous attachment, include an empty attachments array with your request. For more information, see the attachments spec.

Valid message types

Only messages posted by the authenticated user are able to be updated using this method. This includes regular chat messages, as well as messages containing the me_message subtype. Bot users may also update the messages they post.

Attempting to update other message types will return a cant_update_message error.

Response

Typical success response

{
    "ok": true,
    "channel": "C024BE91L",
    "ts": "1401383885.000061",
    "text": "Updated text you carefully authored"
}

Typical error response

{
    "ok": false,
    "error": "cant_update_message"
}

The response includes the text, channel and timestamp properties of the updated message so clients can keep their local copies of the message in sync.

Bot users

To use chat.update with a bot user token, you'll need to think of your bot user as a user, and pass as_user set to true while editing a message created by that same bot user.

Interactive messages with buttons

If you're posting message with buttons, you may use chat.update to continue updating ongoing state changes around a message. Provide the ts field the message you're updating and follow the bot user instructions above to update message text, remove or add attachments and actions.

Errors

This table lists the expected errors that this method could return. However, other errors can be returned in the case where the service is down or other unexpected factors affect processing. Callers should always check the value of the ok params in the response.

Error Description
message_not_found

No message exists with the requested timestamp.

cant_update_message

Authenticated user does not have permission to update this message.

channel_not_found

Value passed for channel was invalid.

edit_window_closed

The message cannot be edited due to the team message edit settings

msg_too_long

Message text is too long

too_many_attachments

Too many attachments were provided with this message. A maximum of 100 attachments are allowed on a message.

no_text

No message text provided

not_authed

No authentication token provided.

invalid_auth

Invalid authentication token.

account_inactive

Authentication token is for a deleted user or workspace.

no_permission

The workspace token used in this request does not have the permissions necessary to complete the request.

invalid_arg_name

The method was passed an argument whose name falls outside the bounds of accepted or expected values. This includes very long names and names with non-alphanumeric characters other than _. If you get this error, it is typically an indication that you have made a very malformed API call.

invalid_array_arg

The method was passed a PHP-style array argument (e.g. with a name like foo[7]). These are never valid with the Slack API.

invalid_charset

The method was called via a POST request, but the charset specified in the Content-Type header was invalid. Valid charset names are: utf-8 iso-8859-1.

invalid_form_data

The method was called via a POST request with Content-Type application/x-www-form-urlencoded or multipart/form-data, but the form data was either missing or syntactically invalid.

invalid_post_type

The method was called via a POST request, but the specified Content-Type was invalid. Valid types are: application/x-www-form-urlencoded multipart/form-data text/plain.

missing_post_type

The method was called via a POST request and included a data payload, but the request did not include a Content-Type header.

team_added_to_org

The workspace associated with your request is currently undergoing migration to an Enterprise Organization. Web API and other platform operations will be intermittently unavailable until the transition is complete.

request_timeout

The method was called via a POST request, but the POST data was either missing or truncated.

Warnings

This table lists the expected warnings that this method will return. However, other warnings can be returned in the case where the service is experiencing unexpected trouble.

Warning Description
missing_charset

The method was called via a POST request, and recommended practice for the specified Content-Type is to include a charset parameter. However, no charset was present. Specifically, non-form-data content types (e.g. text/plain) are the ones for which charset is recommended.

superfluous_charset

The method was called via a POST request, and the specified Content-Type is not defined to understand the charset parameter. However, charset was in fact present. Specifically, form-data content types (e.g. multipart/form-data) are the ones for which charset is superfluous.

Argument Value
token Required Generate tokens to test with here.
channel Required
text Required
ts Required
as_user Optional
attachments Optional
link_names Optional
parse Optional
Extra args