Skip to main content
POST
/
conversations
/
{conversationId}
/
messages
Send a message in an existing conversation
curl --request POST \
  --url https://rest.breakcold.com/api/v1/conversations/{conversationId}/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "textPlain": "<string>",
  "clientMessageId": "<string>",
  "textHtml": "<string>",
  "replyToMessageId": "<string>",
  "attachments": [
    {
      "storageId": "<string>",
      "filename": "<string>",
      "mimeType": "<string>"
    }
  ]
}
'
import requests

url = "https://rest.breakcold.com/api/v1/conversations/{conversationId}/messages"

payload = {
    "textPlain": "<string>",
    "clientMessageId": "<string>",
    "textHtml": "<string>",
    "replyToMessageId": "<string>",
    "attachments": [
        {
            "storageId": "<string>",
            "filename": "<string>",
            "mimeType": "<string>"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    textPlain: '<string>',
    clientMessageId: '<string>',
    textHtml: '<string>',
    replyToMessageId: '<string>',
    attachments: [{storageId: '<string>', filename: '<string>', mimeType: '<string>'}]
  })
};

fetch('https://rest.breakcold.com/api/v1/conversations/{conversationId}/messages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://rest.breakcold.com/api/v1/conversations/{conversationId}/messages",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'textPlain' => '<string>',
    'clientMessageId' => '<string>',
    'textHtml' => '<string>',
    'replyToMessageId' => '<string>',
    'attachments' => [
        [
                'storageId' => '<string>',
                'filename' => '<string>',
                'mimeType' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://rest.breakcold.com/api/v1/conversations/{conversationId}/messages"

	payload := strings.NewReader("{\n  \"textPlain\": \"<string>\",\n  \"clientMessageId\": \"<string>\",\n  \"textHtml\": \"<string>\",\n  \"replyToMessageId\": \"<string>\",\n  \"attachments\": [\n    {\n      \"storageId\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"mimeType\": \"<string>\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://rest.breakcold.com/api/v1/conversations/{conversationId}/messages")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"textPlain\": \"<string>\",\n  \"clientMessageId\": \"<string>\",\n  \"textHtml\": \"<string>\",\n  \"replyToMessageId\": \"<string>\",\n  \"attachments\": [\n    {\n      \"storageId\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"mimeType\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://rest.breakcold.com/api/v1/conversations/{conversationId}/messages")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"textPlain\": \"<string>\",\n  \"clientMessageId\": \"<string>\",\n  \"textHtml\": \"<string>\",\n  \"replyToMessageId\": \"<string>\",\n  \"attachments\": [\n    {\n      \"storageId\": \"<string>\",\n      \"filename\": \"<string>\",\n      \"mimeType\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "conversation": {
    "id": "<string>",
    "workspaceId": "<string>",
    "lastMessageAtMs": 123,
    "isClosed": true,
    "subject": "<string>",
    "lifecycle": "<string>",
    "mailbox": "<string>",
    "lastMessageSnippet": "<string>",
    "hasAttachments": true,
    "hasLinkedRecords": true,
    "attendees": [
      {
        "id": "<string>",
        "displayName": "<string>",
        "handle": "<string>",
        "email": "<string>",
        "isSender": true,
        "isWorkspaceMember": true
      }
    ],
    "assignees": [
      {
        "id": "<string>",
        "name": "<string>",
        "email": "<string>"
      }
    ]
  },
  "message": {
    "id": "<string>",
    "workspaceId": "<string>",
    "conversationId": "<string>",
    "sentAtMs": 123,
    "textPlain": "<string>",
    "textHtml": "<string>",
    "subject": "<string>",
    "receivedAtMs": 123,
    "attachmentCount": 123
  },
  "providerMessageId": "<string>"
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>",
    "retryAfterMs": 123
  }
}

Authorizations

Authorization
string
header
required

Breakcold public API key, for example Bearer bc_live_....

Headers

X-Breakcold-Organization-Id
string

Breakcold organization ID. API keys already carry their organization, so most API-key requests do not need this header. Use it only when Breakcold asks you to choose an organization for a signed-in user token.

Path Parameters

conversationId
string
required

Body

application/json
textPlain
string
required
clientMessageId
string
textHtml
string
replyToMessageId
string
attachments
object[]
email
object

Response

Success

conversation
object
required
message
object
required
providerMessageId
string