Messages

Update a message

Changed on

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.

patch/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/conversations/custom-channels/2026-03/{channelId}/messages/{messageId}
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Path parameters

channelIdinteger required
messageIdstring required

Request body

errorMessagestring
statusType'FAILED' | 'READ' | 'SENT' required

Valid status are SENT, FAILED, and READ

Response

successful operation

archivedboolean required
channelAccountIdstring required
channelIdstring required
conversationsThreadIdstring required
createdAtstring date-time required
createdBystring required
direction'INCOMING' | 'OUTGOING' required
idstring required
inReplyToIdstring
richTextstring
subjectstring
textstring required
truncationStatus'NOT_TRUNCATED' | 'TRUNCATED' | 'TRUNCATED_TO_MOST_RECENT_REPLY' required
type'MESSAGE' required
updatedAtstring date-time

Changes

Some revisions have not been checked yet.