Skip to main content
PATCH
Edit message

Path Parameters

messageId
string
required
Pattern: ^[0-9a-z]+$

Body

application/json
content
string
required
Minimum string length: 1

Response

A message in a thread, sent or received by its account link.

A message in a thread, sent or received by its account link.

id
string
required
threadId
string
required

A thread: a conversation between one of the team's account links and one profile.

An account link: a platform account the team connected to Inboxapp, the team's side of a conversation.

platform
string
required

The platform. Every team can use twitter; a team may have others enabled.

Example:

"twitter"

platformId
string | null
required

Null when the platform assigned none.

direction
enum<string>
required

inbound was received from the other side. outbound was sent by the account link.

Available options:
inbound,
outbound
sentBy
object
required

Who on the team sent an outbound message. Null for inbound messages and for messages sent outside Inboxapp.

content
string
required

The text as Inboxapp last saw it. A deleted message keeps its content.

entities
object
required

Parts of content the platform marked up.

attachments
object[]
required

Media, and at most one link card, told apart by kind.

An image, GIF, video, audio clip or file. Its url expires, so fetch it again when needed.

forwarded
object | null
required

Set when the message forwards another one, with the forwarded text as the sender's app declared it. Null otherwise.

reactions
object[]
required
editedAt
string<date-time> | null
required

When the message was last edited. Null when it hasn't been, or when the edit time wasn't recorded. Every version is in GET /messages/{messageId}/history.

Example:

"2026-09-14T10:32:00.000Z"

deletedAt
string<date-time> | null
required

Set once the message was deleted for the account link or unsent for everyone. Deleted messages stay in lists, and GET /messages/{messageId}/history has the scope.

Example:

"2026-09-14T10:32:00.000Z"

createdAt
string<date-time>
required
Example:

"2026-09-14T10:32:00.000Z"

platformData
object
required

Fields only one platform has, tagged by _tag. Ignore tags you don't know.

replyTo
object | null
required

The message this one replies to. Null when it isn't a reply.

thread
object

A conversation between one of the team's account links and one profile.

A platform account the team connected to Inboxapp. Every conversation and message goes through one.