Pular para o conteúdo principal
PATCH
/
conversations
/
v3
/
custom-channels
/
{channelId}
/
messages
/
{messageId}
Atualizar uma mensagem
curl --request PATCH \
  --url https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/messages/{messageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "statusType": "FAILED",
  "errorMessage": "<string>"
}
'
{
  "archived": true,
  "attachments": [
    {
      "fileId": "<string>",
      "fileUsageType": "<string>",
      "type": "FILE",
      "name": "<string>",
      "url": "<string>"
    }
  ],
  "channelAccountId": "<string>",
  "channelId": "<string>",
  "client": {
    "clientType": "HUBSPOT",
    "integrationAppId": 123
  },
  "conversationsThreadId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "direction": "INCOMING",
  "id": "<string>",
  "recipients": [
    {
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      },
      "actorId": "<string>",
      "name": "<string>",
      "recipientField": "<string>"
    }
  ],
  "senders": [
    {
      "actorId": "<string>",
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      },
      "name": "<string>",
      "senderField": "<string>"
    }
  ],
  "text": "<string>",
  "truncationStatus": "NOT_TRUNCATED",
  "type": "MESSAGE",
  "inReplyToId": "<string>",
  "richText": "<string>",
  "status": {
    "statusType": "FAILED",
    "failureDetails": {
      "errorMessageTokens": {},
      "errorMessage": "<string>"
    }
  },
  "subject": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Professional
Service HubService Hub -Professional
Content HubContent Hub -Grátis

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 canal pelo qual a mensagem foi enviada

messageId
string
obrigatório

O ID da mensagem

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

Resposta

successful operation

archived
boolean
obrigatório
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
channelAccountId
string
obrigatório
channelId
string
obrigatório
client
object
obrigatório
conversationsThreadId
string
obrigatório
createdAt
string<date-time>
obrigatório
createdBy
string
obrigatório
direction
enum<string>
obrigatório
Opções disponíveis:
INCOMING,
OUTGOING
id
string
obrigatório
recipients
object[]
obrigatório
senders
object[]
obrigatório
text
string
obrigatório
truncationStatus
enum<string>
obrigatório
Opções disponíveis:
NOT_TRUNCATED,
TRUNCATED,
TRUNCATED_TO_MOST_RECENT_REPLY
type
enum<string>
padrão:MESSAGE
obrigatório
Opções disponíveis:
MESSAGE
inReplyToId
string
richText
string
status
object
subject
string
updatedAt
string<date-time>
Last modified on December 8, 2025