Messages

Publish a message

Changed on

Publish a message over your custom channel

post/conversations/v3/custom-channels/{channelId}/messages

Request

  • Base URL
    https://api.hubapi.com
  • Auth
    OAuth 2
    Authorization codehttps://app.hubspot.com/oauth/authorize
    Token URLhttps://api.hubapi.com/oauth/v1/token
    Scopesconversations.custom_channels.write

Path parameters

channelIdinteger required

The ID of the channel.

Request body

associateWithContactIdinteger
channelAccountIdstring required
inReplyToIdstring
integrationIdempotencyIdstring
integrationThreadIdstring
messageDirection'INCOMING' | 'OUTGOING' required
richTextstring
textstring required
timestampstring date-time required

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

    • info

      added the new hs_geocode_mapping_id enum value to the request property ////

    • info

      added the new hs_sms_mobilephone_communication_subscriptions_opted_in enum value to the request property ////

    • info

      added the new hs_sms_mobilephone_communication_subscriptions_opted_out enum value to the request property ////

    • info

      added the new hs_sms_phone_communication_subscriptions_opted_in enum value to the request property ////

    • info

      added the new hs_sms_phone_communication_subscriptions_opted_out enum value to the request property ////