curl --request PATCH \
--url https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/messages/{messageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"statusType": "SENT",
"errorMessage": "<string>"
}'
{
"attachments": [
{
"fileUsageType": "<string>",
"name": "<string>",
"type": "FILE",
"url": "<string>",
"fileId": "<string>"
}
],
"subject": "<string>",
"conversationsThreadId": "<string>",
"type": "MESSAGE",
"richText": "<string>",
"inReplyToId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"archived": true,
"createdBy": "<string>",
"recipients": [
{
"actorId": "<string>",
"name": "<string>",
"deliveryIdentifier": {
"type": "<string>",
"value": "<string>"
},
"recipientField": "<string>"
}
],
"truncationStatus": "NOT_TRUNCATED",
"client": {
"clientType": "HUBSPOT",
"integrationAppId": 123
},
"id": "<string>",
"text": "<string>",
"channelAccountId": "<string>",
"senders": [
{
"actorId": "<string>",
"name": "<string>",
"senderField": "<string>",
"deliveryIdentifier": {
"type": "<string>",
"value": "<string>"
}
}
],
"channelId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"status": {
"statusType": "SENT",
"failureDetails": {
"errorMessageTokens": {},
"errorMessage": "<string>"
}
},
"direction": "INCOMING"
}
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.
curl --request PATCH \
--url https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/messages/{messageId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"statusType": "SENT",
"errorMessage": "<string>"
}'
{
"attachments": [
{
"fileUsageType": "<string>",
"name": "<string>",
"type": "FILE",
"url": "<string>",
"fileId": "<string>"
}
],
"subject": "<string>",
"conversationsThreadId": "<string>",
"type": "MESSAGE",
"richText": "<string>",
"inReplyToId": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"archived": true,
"createdBy": "<string>",
"recipients": [
{
"actorId": "<string>",
"name": "<string>",
"deliveryIdentifier": {
"type": "<string>",
"value": "<string>"
},
"recipientField": "<string>"
}
],
"truncationStatus": "NOT_TRUNCATED",
"client": {
"clientType": "HUBSPOT",
"integrationAppId": 123
},
"id": "<string>",
"text": "<string>",
"channelAccountId": "<string>",
"senders": [
{
"actorId": "<string>",
"name": "<string>",
"senderField": "<string>",
"deliveryIdentifier": {
"type": "<string>",
"value": "<string>"
}
}
],
"channelId": "<string>",
"updatedAt": "2023-11-07T05:31:56Z",
"status": {
"statusType": "SENT",
"failureDetails": {
"errorMessageTokens": {},
"errorMessage": "<string>"
}
},
"direction": "INCOMING"
}
conversations.custom_channels.write
The access token received from the authorization server in the OAuth 2.0 flow.
successful operation
The response is of type object
.
Was this page helpful?