Set a conversation draft
curl --request PATCH \
--url https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"textPlain": "<string>",
"textHtml": "<string>"
}
'import requests
url = "https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft"
payload = {
"textPlain": "<string>",
"textHtml": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({textPlain: '<string>', textHtml: '<string>'})
};
fetch('https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft', 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}/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'textPlain' => '<string>',
'textHtml' => '<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}/draft"
payload := strings.NewReader("{\n \"textPlain\": \"<string>\",\n \"textHtml\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"textPlain\": \"<string>\",\n \"textHtml\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"textPlain\": \"<string>\",\n \"textHtml\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"draft": {
"id": "<string>",
"workspaceId": "<string>",
"conversationId": "<string>",
"textPlain": "<string>",
"createdAt": 123,
"updatedAt": 123,
"textHtml": "<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
}
}Inbox
Set a conversation draft
Create or update the authenticated effective user’s private draft. Blank content clears the draft. HTML is accepted for email conversations only.
| Token cost | Rate limit |
|---|---|
| 0.4 tokens | 120 requests/min per route/org |
PATCH
/
conversations
/
{conversationId}
/
draft
Set a conversation draft
curl --request PATCH \
--url https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"textPlain": "<string>",
"textHtml": "<string>"
}
'import requests
url = "https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft"
payload = {
"textPlain": "<string>",
"textHtml": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({textPlain: '<string>', textHtml: '<string>'})
};
fetch('https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft', 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}/draft",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'textPlain' => '<string>',
'textHtml' => '<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}/draft"
payload := strings.NewReader("{\n \"textPlain\": \"<string>\",\n \"textHtml\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"textPlain\": \"<string>\",\n \"textHtml\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://rest.breakcold.com/api/v1/conversations/{conversationId}/draft")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"textPlain\": \"<string>\",\n \"textHtml\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"draft": {
"id": "<string>",
"workspaceId": "<string>",
"conversationId": "<string>",
"textPlain": "<string>",
"createdAt": 123,
"updatedAt": 123,
"textHtml": "<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
ApiKeyBearerBreakcoldOAuth
Breakcold public API key, for example Bearer bc_live_....
Headers
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.
Stable unique key for the intended write. Reuse the same key when retrying the same request; use a different key for an intentional duplicate.
Required string length:
1 - 200Path Parameters
Body
application/json
Response
Success
Show child attributes
Show child attributes
Was this page helpful?
⌘I