Publish a message
POST {{baseUrl}}/conversations/v3/custom-channels/:channelId/messages
Publish a message over your custom channel
Request Body
{"attachments"=>[{"fileId"=>"<string>", "type"=>"FILE", "fileUsageType"=>"<string>"}, {"fileId"=>"<string>", "type"=>"FILE", "fileUsageType"=>"<string>"}], "channelAccountId"=>"<string>", "messageDirection"=>"OUTGOING", "recipients"=>[{"deliveryIdentifier"=>{"type"=>"<string>", "value"=>"<string>"}, "name"=>"<string>"}, {"deliveryIdentifier"=>{"type"=>"<string>", "value"=>"<string>"}, "name"=>"<string>"}], "senders"=>[{"deliveryIdentifier"=>{"type"=>"<string>", "value"=>"<string>"}, "name"=>"<string>"}, {"deliveryIdentifier"=>{"type"=>"<string>", "value"=>"<string>"}, "name"=>"<string>"}], "text"=>"<string>", "timestamp"=>"<dateTime>", "integrationThreadId"=>"<string>", "integrationIdempotencyId"=>"<string>", "richText"=>"<string>", "inReplyToId"=>"<string>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"archived":"\u003cboolean\u003e","attachments":[{"fileId":"\u003cstring\u003e","fileUsageType":"\u003cstring\u003e","type":"FILE","name":"\u003cstring\u003e","url":"\u003cstring\u003e"},{"fileId":"\u003cstring\u003e","fileUsageType":"\u003cstring\u003e","type":"FILE","name":"\u003cstring\u003e","url":"\u003cstring\u003e"}],"channelAccountId":"\u003cstring\u003e","channelId":"\u003cstring\u003e","client":{"clientType":"HUBSPOT","integrationAppId":"\u003cinteger\u003e"},"conversationsThreadId":"\u003cstring\u003e","createdAt":"\u003cdateTime\u003e","createdBy":"\u003cstring\u003e","direction":"INCOMING","id":"\u003cstring\u003e","recipients":[{"deliveryIdentifier":{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"},"actorId":"\u003cstring\u003e","name":"\u003cstring\u003e","recipientField":"\u003cstring\u003e"},{"deliveryIdentifier":{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"},"actorId":"\u003cstring\u003e","name":"\u003cstring\u003e","recipientField":"\u003cstring\u003e"}],"senders":[{"actorId":"\u003cstring\u003e","name":"\u003cstring\u003e","senderField":"\u003cstring\u003e","deliveryIdentifier":{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"}},{"actorId":"\u003cstring\u003e","name":"\u003cstring\u003e","senderField":"\u003cstring\u003e","deliveryIdentifier":{"type":"\u003cstring\u003e","value":"\u003cstring\u003e"}}],"text":"\u003cstring\u003e","truncationStatus":"NOT_TRUNCATED","type":"MESSAGE","subject":"\u003cstring\u003e","richText":"\u003cstring\u003e","inReplyToId":"\u003cstring\u003e","updatedAt":"\u003cdateTime\u003e","status":{"statusType":"FAILED","failureDetails":{"errorMessageTokens":{"pariaturaf4":"\u003cstring\u003e","essed24":"\u003cstring\u003e"},"errorMessage":"\u003cstring\u003e"}}}