Publish a message
Publish a message over your custom channel
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 where the message will be created.
Body
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
- SOCIAL_MEDIA_METADATA
The ID of the channel account through which the message is sent.
The direction of the message, indicating whether it is 'INCOMING' or 'OUTGOING'.
INCOMING, OUTGOING An array of participants representing the recipients of the message.
An array of participants representing the senders of the message.
The plain text content of the message.
The date and time when the message was created, in ISO 8601 format.
The ID of the contact with which this message should be associated.
The ID of the message this message is replying to.
A unique identifier to ensure idempotency of the message within the integration.
A unique identifier for the thread within the integration.
The rich text content of the message, allowing for formatting.
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.