Reply in a thread

curl --request POST \
  --url https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'body_text=<string>' \
  --form 'bcc=<string>' \
  --form 'cc=<string>' \
  --form 'files=<string>' \
  --form include_history=false \
  --form mailbox_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form omit_signature=false \
  --form reply_to_message_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form 'subject=<string>' \
  --form 'to=<string>' \
  --form files.0.items='@example-file'

import requests

url = "https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/"

files = { "files.0.items": ("example-file", open("example-file", "rb")) }
payload = {
    "body_text": "<string>",
    "bcc": "<string>",
    "cc": "<string>",
    "files": "<string>",
    "include_history": "false",
    "mailbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "omit_signature": "false",
    "reply_to_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subject": "<string>",
    "to": "<string>"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('body_text', '<string>');
form.append('bcc', '<string>');
form.append('cc', '<string>');
form.append('files', '<string>');
form.append('include_history', 'false');
form.append('mailbox_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('omit_signature', 'false');
form.append('reply_to_message_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('subject', '<string>');
form.append('to', '<string>');
form.append('files.0.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/', 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://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body_text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bcc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_history\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailbox_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"omit_signature\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reply_to_message_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"to\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body_text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bcc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_history\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailbox_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"omit_signature\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reply_to_message_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"to\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body_text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bcc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_history\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailbox_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"omit_signature\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reply_to_message_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"to\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body_text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bcc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_history\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailbox_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"omit_signature\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reply_to_message_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"to\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "attachments": [
    {
      "content_type": "<string>",
      "filename": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "size_bytes": 123
    }
  ],
  "body_text": "<string>",
  "bounce_severity": "hard",
  "channel": "email",
  "direction": "outbound",
  "from_address": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mailbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message_class": "reply",
  "send_state": "sent",
  "sent_at": "2023-11-07T05:31:56Z",
  "subject": "<string>",
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_address": "<string>",
  "body_html": "<string>",
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

inbox

Reply in a thread

Sends from the mailbox that owns the conversation — the prospect always sees a reply from the address that emailed them. Free of credits. Attachments ride on the email (multipart form). INB-09: channel overrides which channel the reply goes out on when both identities are known; absent, the thread’s own channel decides. A pick the thread cannot honour returns 422 with the reason. INB-10: to redirects the reply (first address is the To line, the rest ride as CC) and bcc rides blind; both are email-only. INB-12: omit_signature skips the mailbox signature append, for a composer whose body already carries it as visible text.

POST

inbox

threads

{thread_id}

Reply in a thread

curl --request POST \
  --url https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'body_text=<string>' \
  --form 'bcc=<string>' \
  --form 'cc=<string>' \
  --form 'files=<string>' \
  --form include_history=false \
  --form mailbox_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form omit_signature=false \
  --form reply_to_message_id=3c90c3cc-0d44-4b50-8888-8dd25736052a \
  --form 'subject=<string>' \
  --form 'to=<string>' \
  --form files.0.items='@example-file'

import requests

url = "https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/"

files = { "files.0.items": ("example-file", open("example-file", "rb")) }
payload = {
    "body_text": "<string>",
    "bcc": "<string>",
    "cc": "<string>",
    "files": "<string>",
    "include_history": "false",
    "mailbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "omit_signature": "false",
    "reply_to_message_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "subject": "<string>",
    "to": "<string>"
}
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('body_text', '<string>');
form.append('bcc', '<string>');
form.append('cc', '<string>');
form.append('files', '<string>');
form.append('include_history', 'false');
form.append('mailbox_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('omit_signature', 'false');
form.append('reply_to_message_id', '3c90c3cc-0d44-4b50-8888-8dd25736052a');
form.append('subject', '<string>');
form.append('to', '<string>');
form.append('files.0.items', '{
  "fileName": "example-file"
}');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/', 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://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body_text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bcc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_history\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailbox_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"omit_signature\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reply_to_message_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"to\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body_text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bcc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_history\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailbox_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"omit_signature\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reply_to_message_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"to\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body_text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bcc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_history\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailbox_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"omit_signature\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reply_to_message_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"to\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getoneprofile.ai/inbox/threads/{thread_id}/reply/")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"body_text\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bcc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"cc\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_history\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailbox_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"omit_signature\"\r\n\r\nfalse\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"reply_to_message_id\"\r\n\r\n3c90c3cc-0d44-4b50-8888-8dd25736052a\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"to\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"files.0.items\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n{\r\n  \"fileName\": \"example-file\"\r\n}\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "attachments": [
    {
      "content_type": "<string>",
      "filename": "<string>",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "size_bytes": 123
    }
  ],
  "body_text": "<string>",
  "bounce_severity": "hard",
  "channel": "email",
  "direction": "outbound",
  "from_address": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "mailbox_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "message_class": "reply",
  "send_state": "sent",
  "sent_at": "2023-11-07T05:31:56Z",
  "subject": "<string>",
  "thread_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "to_address": "<string>",
  "body_html": "<string>",
  "sequence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "step_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "issues": [
    {
      "input": "<string>",
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

thread_id

string<uuid>

required

Body

multipart/form-data

body_text

string

required

Required string length: 1 - 100000

bcc

string | null

Maximum string length: 2000

string | null

Maximum string length: 2000

channel

enum<string> | null

Which surface a conversation happens on.

Threads are contact-scoped, not channel-scoped, so this says how a thread is REACHED rather than partitioning the inbox: a reply arrives, is classified and stops the cadence identically either way, and only the send path differs.

Available options:

email,

linkedin

files

file[] | null

include_history

boolean

default:false

mailbox_id

string<uuid> | null

omit_signature

boolean

default:false

reply_to_message_id

string<uuid> | null

subject

string | null

Maximum string length: 998

string | null

Maximum string length: 2000

Response

Successful Response

attachments

AttachmentReadSchema · object[]

required

Show child attributes

body_text

string

required

bounce_severity

enum<string> | null

required

NEW-A: hard vs soft severity of a BOUNCE message.

Only HARD marks the contact bounced (§29's condition, the enrolment analytics bounce rate, §57's per-message outcome) — SOFT still fills the Bounces view and never looks like a reply, but the address may still be reachable, so the cadence is left alone.

Available options:

hard,

soft

channel

enum<string>

required

INB-25: this message's own channel. Threads merge channels, so the reader captions each message by what it actually is — a LinkedIn DM involves no email addresses.

Available options:

email,

linkedin

direction

enum<string>

required

Available options:

outbound,

inbound

from_address

string

required

string<uuid>

required

mailbox_id

string<uuid> | null

required

message_class

enum<string> | null

required

What an inbound message turned out to be.

REPLY stops the cadence; BOUNCE (a DSN) marks the contact bounced and never looks like a reply; OUT_OF_OFFICE never stops anything and defers the cadence to the stated return when one is parsed.

Available options:

reply,

bounce,

out_of_office

send_state

enum<string>

required

Whether a message has actually left.

Only meaningful on LinkedIn. An email row is written after the provider accepted it, so it is SENT the moment it exists; a LinkedIn reply is written when it is QUEUED, and cannot become SENT until the customer's own browser has delivered it. Showing the two the same way would have the product assert a delivery it has no evidence for.

Available options:

sent,

queued,

failed

sent_at

string<date-time>

required

subject

string

required

thread_id

string<uuid>

required

to_address

string

required

body_html

string | null

INB-09: the sender's raw HTML part; sanitise before rendering.

sequence_id

string<uuid> | null

§78: the sequence this message was sent from, when it came from one.

step_id

string<uuid> | null

§78: which step sent this message — carried per-message (not just on the thread) because a contact re-enrolled in a different sequence keeps their earlier messages' own sequence/step, distinct from the thread's current one.

API reference

Endpoints

Reply in a thread

Authorizations

Path Parameters

Body

Response