Update a message
Update a message’s status to indicate if it was successfully sent, failed to send, or was read. For failed messages, this can also include the error message for the failure.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
- Authorization URL
- https://app.hubspot.com/oauth/authorize
- Token URL
- https://api.hubapi.com/oauth/v1/token
Path Parameters
The unique identifier of the custom channel that contains the message.
The unique identifier of the message to update.
Body
Response
successful operation
A boolean indicating whether the message is archived.
An array of attachments included with the message, which can be files, locations, contacts, or other supported types.
- FILE
- LOCATION
- CONTACT
- UNSUPPORTED_CONTENT
- MESSAGE_HEADER
- QUICK_REPLIES
- WHATSAPP_TEMPLATE_METADATA
- SOCIAL_MEDIA_METADATA
The identifier of the channel account associated with the message.
The identifier of the channel through which the message was sent.
The identifier for the conversation thread to which this message belongs.
The date and time when the message was created, in ISO 8601 format.
The identifier of the user or system that created the message.
The direction of the message, either 'INCOMING' or 'OUTGOING'.
INCOMING, OUTGOING The unique identifier for the message.
An array of recipients of the message, each containing recipient details.
An array of senders associated with the message, each containing sender details.
The plain text content of the message.
Indicates whether the message content is truncated. Valid values are 'NOT_TRUNCATED', 'TRUNCATED_TO_MOST_RECENT_REPLY', and 'TRUNCATED'.
NOT_TRUNCATED, TRUNCATED, TRUNCATED_TO_MOST_RECENT_REPLY The type of the message, which is always 'MESSAGE'.
MESSAGE The identifier of the message to which this message is a reply, if applicable.
The rich text content of the message, if available.
The subject of the message, if applicable.
The date and time when the message was last updated, in ISO 8601 format.