Pular para o conteúdo principal
PATCH
Atualizar uma mensagem

Supported products

Autorizações

Authorization
string
header
obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Parâmetros de caminho

channelId
integer<int32>
obrigatório

O identificador exclusivo do canal personalizado que contém a mensagem.

messageId
string
obrigatório

O identificador exclusivo da mensagem a ser atualizada.

Corpo

application/json
statusType
enum<string>
obrigatório

Os status válidos são ENVIADO, FALHOU e LIDO

Opções disponíveis:
FAILED,
READ,
SENT
errorMessage
string

Uma string contendo uma mensagem de erro, se aplicável.

Resposta

successful operation

archived
boolean
obrigatório

Booleano que indica se a mensagem está arquivada.

attachments
(FILE · object | LOCATION · object | CONTACT · object | UNSUPPORTED_CONTENT · object | MESSAGE_HEADER · object | QUICK_REPLIES · object | WHATSAPP_TEMPLATE_METADATA · object | SOCIAL_MEDIA_METADATA · object)[]
obrigatório

Uma matriz de anexos incluídos na mensagem, que podem ser arquivos, localizações, contatos ou outros tipos compatíveis.

channelAccountId
string
obrigatório

O identificador da conta de canal associada à mensagem.

channelId
string
obrigatório

O identificador do canal pelo qual a mensagem foi enviada.

client
object
obrigatório
conversationsThreadId
string
obrigatório

O identificador do thread de conversa ao qual esta mensagem pertence.

createdAt
string<date-time>
obrigatório

A data e a hora em que a mensagem foi criada, no formato ISO 8601.

createdBy
string
obrigatório

O identificador do usuário ou sistema que criou a mensagem.

direction
enum<string>
obrigatório

A direção da mensagem, seja "INCOMING" ou "OUTGOING".

Opções disponíveis:
INCOMING,
OUTGOING
id
string
obrigatório

O identificador exclusivo da mensagem.

recipients
object[]
obrigatório

Uma matriz de destinatários da mensagem, cada um contendo detalhes do destinatário.

senders
object[]
obrigatório

Uma matriz de remetentes associados à mensagem, cada um contendo detalhes do remetente.

text
string
obrigatório

O conteúdo de texto simples da mensagem.

truncationStatus
enum<string>
obrigatório

Indica se o conteúdo da mensagem está truncado. Os valores válidos são "NOT_TRUNCATED", "TRUNCATED_TO_MOST_RECENT_REPLY" e "TRUNCATED".

Opções disponíveis:
NOT_TRUNCATED,
TRUNCATED,
TRUNCATED_TO_MOST_RECENT_REPLY
type
enum<string>
padrão:MESSAGE
obrigatório

O tipo da mensagem, que é sempre 'MESSAGE'.

Opções disponíveis:
MESSAGE
inReplyToId
string

O identificador da mensagem a que esta mensagem responde, se aplicável.

richText
string

O conteúdo de rich text da mensagem, se disponível.

status
object
subject
string

O assunto da mensagem, se aplicável.

updatedAt
string<date-time>

A data e a hora da última atualização da mensagem, no formato ISO 8601.

Última modificação em 6 de outubro de 2026