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>",
  "richText": "<string>",
  "attachments": [
    {
      "type": "FILE",
      "fileId": "<string>"
    }
  ],
  "recipients": [
    {
      "deliveryIdentifiers": [
        {
          "type": "<string>",
          "value": "<string>"
        }
      ],
      "actorId": "<string>",
      "name": "<string>",
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      },
      "recipientField": "<string>"
    }
  ],
  "senderActorId": "<string>",
  "channelId": "<string>",
  "channelAccountId": "<string>",
  "subject": "<string>"
}'
{
  "type": "MESSAGE",
  "id": "<string>",
  "conversationsThreadId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "client": {
    "clientType": "HUBSPOT",
    "integrationAppId": 123
  },
  "senders": [
    {
      "actorId": "<string>",
      "name": "<string>",
      "senderField": "<string>",
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      }
    }
  ],
  "recipients": [
    {
      "actorId": "<string>",
      "name": "<string>",
      "deliveryIdentifier": {
        "type": "<string>",
        "value": "<string>"
      },
      "recipientField": "<string>"
    }
  ],
  "archived": true,
  "text": "<string>",
  "richText": "<string>",
  "attachments": [
    {
      "fileUsageType": "<string>",
      "name": "<string>",
      "type": "FILE",
      "url": "<string>",
      "fileId": "<string>"
    }
  ],
  "subject": "<string>",
  "truncationStatus": "NOT_TRUNCATED",
  "inReplyToId": "<string>",
  "status": {
    "statusType": "SENT",
    "failureDetails": {
      "errorMessageTokens": {},
      "errorMessage": "<string>"
    }
  },
  "direction": "INCOMING",
  "channelId": "<string>",
  "channelAccountId": "<string>"
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubGratuit

Portées requises

Cette API requiert l’une des portées suivantes :
  • conversations.write

Authorizations

Authorization
string
header
required

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

Body

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

Response

successful operation

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
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