Skip to main content
POST
/
conversations
/
v3
/
conversations
/
threads
/
{threadId}
/
messages
Send a message to a thread
curl --request POST \
  --url https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "MESSAGE",
  "text": "<string>",
  "attachments": [
    {
      "fileId": "<string>",
      "type": "FILE"
    }
  ],
  "recipients": [
    {
      "deliveryIdentifiers": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "actorId": "<string>",
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      },
      "name": "<string>",
      "recipientField": "<string>"
    }
  ],
  "senderActorId": "<string>",
  "channelId": "<string>",
  "channelAccountId": "<string>",
  "richText": "<string>",
  "subject": "<string>"
}
'
{
  "type": "MESSAGE",
  "id": "<string>",
  "conversationsThreadId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "client": {
    "clientType": "HUBSPOT",
    "integrationAppId": 123
  },
  "senders": [
    {
      "actorId": "<string>",
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      },
      "name": "<string>",
      "senderField": "<string>"
    }
  ],
  "recipients": [
    {
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      },
      "actorId": "<string>",
      "name": "<string>",
      "recipientField": "<string>"
    }
  ],
  "archived": true,
  "text": "<string>",
  "attachments": [
    {
      "fileId": "<string>",
      "fileUsageType": "<string>",
      "type": "FILE",
      "name": "<string>",
      "url": "<string>"
    }
  ],
  "truncationStatus": "NOT_TRUNCATED",
  "direction": "INCOMING",
  "channelId": "<string>",
  "channelAccountId": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "richText": "<string>",
  "subject": "<string>",
  "inReplyToId": "<string>",
  "status": {
    "statusType": "FAILED",
    "failureDetails": {
      "errorMessageTokens": {},
      "errorMessage": "<string>"
    }
  }
}

Supported products

Requires one of the following products or higher.
Marketing HubMarketing Hub -Free
Sales HubSales Hub -Free
Service HubService Hub -Free
Content HubContent Hub -Free
This API requires one of the following scopes:
conversations.write

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
threadId
integer<int64>
required

The unique ID of the thread.

Body

application/json
  • Option 1
  • Option 2
​
type
enum<string>
default:MESSAGE
required
Available options:
MESSAGE
​
text
string
required
​
attachments
(FILE · object | QUICK_REPLIES · object | SOCIAL_MEDIA_METADATA · object)[]
required
  • FILE
  • QUICK_REPLIES
  • SOCIAL_MEDIA_METADATA
​
recipients
object[]
required
​
senderActorId
string
required
​
channelId
string
required
​
channelAccountId
string
required
​
richText
string
​
subject
string

Response

successful operation

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
​
type
enum<string>
default:MESSAGE
required
Available options:
MESSAGE
​
id
string
required
​
conversationsThreadId
string
required
​
createdAt
string<date-time>
required
​
createdBy
string
required
​
client
object
required
​
senders
object[]
required
​
recipients
object[]
required
​
archived
boolean
required
​
text
string
required
​
attachments
(FILE · object | LOCATION · object | CONTACT · object | UNSUPPORTED_CONTENT · object | MESSAGE_HEADER · object | QUICK_REPLIES · object | WHATSAPP_TEMPLATE_METADATA · object | SOCIAL_MEDIA_METADATA · object)[]
required
  • FILE
  • LOCATION
  • CONTACT
  • UNSUPPORTED_CONTENT
  • MESSAGE_HEADER
  • QUICK_REPLIES
  • WHATSAPP_TEMPLATE_METADATA
  • SOCIAL_MEDIA_METADATA
​
truncationStatus
enum<string>
required
Available options:
NOT_TRUNCATED,
TRUNCATED_TO_MOST_RECENT_REPLY,
TRUNCATED
​
direction
enum<string>
required
Available options:
INCOMING,
OUTGOING
​
channelId
string
required
​
channelAccountId
string
required
​
updatedAt
string<date-time>
​
richText
string
​
subject
string
​
inReplyToId
string
​
status
object