Skip to main content
PATCH
Update message
This page documents the Legacy API. For new integrations, use Update Message in the Current API.
Required permissions (one of):
  • chat:message:create
  • dms:message:manage
  • livestream:chat:write
  • support_chat:message:create

Autorizaciones

Authorization
string
header
requerido

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

chat:message:create
dms:message:manage
livestream:chat:write
support_chat:message:create

Parámetros de ruta

id
string
requerido

The unique identifier of the message to update.

Cuerpo

application/json

Parameters for UpdateMessage

attachments
FileInputWithId · object[] | null

A replacement list of file attachments for this message, such as images or videos.

content
string | null

The updated body of the message in Markdown format. For example, 'Hello world'.

is_pinned
boolean | null

Whether this message should be pinned to the top of the channel.

Respuesta

A successful response

A message sent within an experience chat, direct message, or group chat.

content
string | null
requerido

The message content formatted as Markdown. Null if the message has no text content.

Ejemplo:

"Hey, are you available for a **quick call**?"

created_at
string<date-time>
requerido

The timestamp when this message was originally created.

Ejemplo:

"2023-12-01T05:00:00.401Z"

id
string
requerido

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

is_edited
boolean
requerido

Whether the message content has been edited after it was originally sent.

is_pinned
boolean
requerido

Whether this message is pinned to the top of the channel for easy access.

mentions
string[]
requerido

A list of user IDs that are explicitly mentioned in this message.

Represents a unique identifier that is Base64 obfuscated. It is often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "VXNlci0xMA==") or integer (such as 4) input value will be accepted as an ID.

mentions_everyone
boolean
requerido

Whether the message includes an @everyone mention that notifies all channel members.

message_type
enum<string>
requerido

The classification of this message: regular, system, or automated.

Opciones disponibles:
regular,
system,
automated
poll
object | null
requerido

A poll attached to this message. Null if the message does not contain a poll.

poll_votes
object[]
requerido

Aggregated reaction counts on this message, filtered to a specific reaction type.

reaction_counts
object[]
requerido

Aggregated reaction counts on this message, filtered to a specific reaction type.

replying_to_message_id
string | null
requerido

The unique identifier of the message this post is replying to. Null if this is not a reply.

updated_at
string<date-time>
requerido

The timestamp when this message was last modified.

Ejemplo:

"2023-12-01T05:00:00.401Z"

user
object
requerido

The user who authored this message.

view_count
integer | null
requerido

The number of unique views this message has received. Null if view tracking is not enabled for this channel.

Ejemplo:

42