Send message
curl --request POST \
--url https://beta.getsales.io/unibox/v1/api/messages/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"body": "<string>",
"conversation_sid": "<string>",
"new_thread": {
"sender_profile_sid": "<string>",
"to": {
"email": "jsmith@example.com",
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"ln_nickname": "<string>",
"person_sid": "<string>"
},
"attendees": [
{
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"ln_nickname": "<string>",
"person_sid": "<string>"
}
],
"title": "<string>"
},
"reply_to_message_sid": "<string>",
"subject": "<string>",
"scheduled_at": "<string>",
"agent_run_sid": "<string>",
"attach_answer_sids": [
"<string>"
]
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/messages/send"
payload = {
"body": "<string>",
"conversation_sid": "<string>",
"new_thread": {
"sender_profile_sid": "<string>",
"to": {
"email": "jsmith@example.com",
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"ln_nickname": "<string>",
"person_sid": "<string>"
},
"attendees": [
{
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"ln_nickname": "<string>",
"person_sid": "<string>"
}
],
"title": "<string>"
},
"reply_to_message_sid": "<string>",
"subject": "<string>",
"scheduled_at": "<string>",
"agent_run_sid": "<string>",
"attach_answer_sids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
body: JSON.stringify('<string>'),
conversation_sid: '<string>',
new_thread: {
sender_profile_sid: '<string>',
to: {
email: 'jsmith@example.com',
ln_member_id: '<string>',
ln_id: '<string>',
sn_id: '<string>',
recruiter_id: '<string>',
ln_nickname: '<string>',
person_sid: '<string>'
},
attendees: [
{
ln_member_id: '<string>',
ln_id: '<string>',
sn_id: '<string>',
recruiter_id: '<string>',
ln_nickname: '<string>',
person_sid: '<string>'
}
],
title: '<string>'
},
reply_to_message_sid: '<string>',
subject: '<string>',
scheduled_at: '<string>',
agent_run_sid: '<string>',
attach_answer_sids: ['<string>']
})
};
fetch('https://beta.getsales.io/unibox/v1/api/messages/send', 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://beta.getsales.io/unibox/v1/api/messages/send",
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([
'body' => '<string>',
'conversation_sid' => '<string>',
'new_thread' => [
'sender_profile_sid' => '<string>',
'to' => [
'email' => 'jsmith@example.com',
'ln_member_id' => '<string>',
'ln_id' => '<string>',
'sn_id' => '<string>',
'recruiter_id' => '<string>',
'ln_nickname' => '<string>',
'person_sid' => '<string>'
],
'attendees' => [
[
'ln_member_id' => '<string>',
'ln_id' => '<string>',
'sn_id' => '<string>',
'recruiter_id' => '<string>',
'ln_nickname' => '<string>',
'person_sid' => '<string>'
]
],
'title' => '<string>'
],
'reply_to_message_sid' => '<string>',
'subject' => '<string>',
'scheduled_at' => '<string>',
'agent_run_sid' => '<string>',
'attach_answer_sids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$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://beta.getsales.io/unibox/v1/api/messages/send"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"conversation_sid\": \"<string>\",\n \"new_thread\": {\n \"sender_profile_sid\": \"<string>\",\n \"to\": {\n \"email\": \"jsmith@example.com\",\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n },\n \"attendees\": [\n {\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n },\n \"reply_to_message_sid\": \"<string>\",\n \"subject\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"agent_run_sid\": \"<string>\",\n \"attach_answer_sids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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://beta.getsales.io/unibox/v1/api/messages/send")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"conversation_sid\": \"<string>\",\n \"new_thread\": {\n \"sender_profile_sid\": \"<string>\",\n \"to\": {\n \"email\": \"jsmith@example.com\",\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n },\n \"attendees\": [\n {\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n },\n \"reply_to_message_sid\": \"<string>\",\n \"subject\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"agent_run_sid\": \"<string>\",\n \"attach_answer_sids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/messages/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"conversation_sid\": \"<string>\",\n \"new_thread\": {\n \"sender_profile_sid\": \"<string>\",\n \"to\": {\n \"email\": \"jsmith@example.com\",\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n },\n \"attendees\": [\n {\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n },\n \"reply_to_message_sid\": \"<string>\",\n \"subject\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"agent_run_sid\": \"<string>\",\n \"attach_answer_sids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"conversation_sid": "<string>",
"channel": "linkedin",
"kind": "linkedin_message",
"direction": "inbound",
"state": "pending_approval",
"origin": "synced",
"body_text": "<string>",
"author": "contact",
"subject": "<string>",
"body_html": "<string>",
"approved_by_user_sid": "<string>",
"agent_run_sid": "<string>",
"ai_confidence": 123,
"ai_source": "<string>",
"workflow_task_sid": "<string>",
"automation_ref": {
"workflow_sid": "<string>",
"workflow_name": "<string>",
"step_id": 1,
"play_sid": "<string>",
"play_name": "<string>"
},
"provider_message_sid": "<string>",
"author_participant_sid": "<string>",
"reactions": [
{
"emoji": "<string>",
"count": 1,
"is_viewer_reacted": true,
"first_reacted_at": "<string>"
}
],
"attachments": [
{
"kind": "voice",
"state": "pending",
"name": "<string>",
"mime": "<string>",
"size": 1,
"pages": 1,
"is_inline": true,
"provider_attachment_id": "<string>",
"reason": "<string>",
"storage_key": "<string>",
"transcript": "<string>",
"transcript_state": "pending"
}
],
"is_wordless": true,
"failure_reason": "<string>",
"scheduled_at": "<string>",
"sent_at": "<string>",
"delivered_at": "<string>",
"opened_at": "<string>",
"clicked_at": "<string>",
"bounced_at": "<string>",
"recalled_at": "<string>",
"recalled_by_user_sid": "<string>",
"person_edited_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"result": {
"gate": "<string>",
"conversation": {
"sid": "<string>"
}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}messages
Send message
The one outbound door for a human, the AI SDR or an external agent: reply into a thread (conversation_sid) or start one (new_thread), exactly one of the two, else 422. channel picks the arm and kind must belong to it; a first email needs subject. A counterpart resolve that cannot ask gtm-api or playtables refuses the send whole (429 gtm_busy, 403 gtm_access_lost or gtm_scope_missing, 503 gtm_unavailable): try again later.
Guards: an agent-authored send whose reason is gone is refused first (409 message_superseded with context.cause: end the turn, a newer plan writes its own); a billing hold is 402; a live sender profile must hold an active account for the channel, else 409 sender_unavailable (a channel the thread has no account for is 422 on channel); an agent send is refused on a do_not_contact thread (409 stoplisted), past the per-thread auto-message cap (429 limit_exceeded) and where the agent is switched off (409 agent_disabled_on_thread). Mode gate: an agent-authored send on a copilot thread is stored as a pending_approval draft, a SUCCESS with result.gate = “pending_approval” (do not retry: a person approves it). A user-authored send always queues. The author is the JWT’s, never the body’s.
The answer is an accepted row, not a receipt: dispatch runs later (scheduled_at, the sender profile’s pace) and re-checks the sender, a reply landed meanwhile and the stoplist. result.conversation is the thread, freshly created on the new_thread arm.
Contract:
- MCP tool
send_message, registry packagemcp.unibox/messages, mountunibox.inbox. - Operation
action, response envelopeaction. - Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
POST
/
api
/
messages
/
send
Send message
curl --request POST \
--url https://beta.getsales.io/unibox/v1/api/messages/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"body": "<string>",
"conversation_sid": "<string>",
"new_thread": {
"sender_profile_sid": "<string>",
"to": {
"email": "jsmith@example.com",
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"ln_nickname": "<string>",
"person_sid": "<string>"
},
"attendees": [
{
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"ln_nickname": "<string>",
"person_sid": "<string>"
}
],
"title": "<string>"
},
"reply_to_message_sid": "<string>",
"subject": "<string>",
"scheduled_at": "<string>",
"agent_run_sid": "<string>",
"attach_answer_sids": [
"<string>"
]
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/messages/send"
payload = {
"body": "<string>",
"conversation_sid": "<string>",
"new_thread": {
"sender_profile_sid": "<string>",
"to": {
"email": "jsmith@example.com",
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"ln_nickname": "<string>",
"person_sid": "<string>"
},
"attendees": [
{
"ln_member_id": "<string>",
"ln_id": "<string>",
"sn_id": "<string>",
"recruiter_id": "<string>",
"ln_nickname": "<string>",
"person_sid": "<string>"
}
],
"title": "<string>"
},
"reply_to_message_sid": "<string>",
"subject": "<string>",
"scheduled_at": "<string>",
"agent_run_sid": "<string>",
"attach_answer_sids": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
body: JSON.stringify('<string>'),
conversation_sid: '<string>',
new_thread: {
sender_profile_sid: '<string>',
to: {
email: 'jsmith@example.com',
ln_member_id: '<string>',
ln_id: '<string>',
sn_id: '<string>',
recruiter_id: '<string>',
ln_nickname: '<string>',
person_sid: '<string>'
},
attendees: [
{
ln_member_id: '<string>',
ln_id: '<string>',
sn_id: '<string>',
recruiter_id: '<string>',
ln_nickname: '<string>',
person_sid: '<string>'
}
],
title: '<string>'
},
reply_to_message_sid: '<string>',
subject: '<string>',
scheduled_at: '<string>',
agent_run_sid: '<string>',
attach_answer_sids: ['<string>']
})
};
fetch('https://beta.getsales.io/unibox/v1/api/messages/send', 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://beta.getsales.io/unibox/v1/api/messages/send",
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([
'body' => '<string>',
'conversation_sid' => '<string>',
'new_thread' => [
'sender_profile_sid' => '<string>',
'to' => [
'email' => 'jsmith@example.com',
'ln_member_id' => '<string>',
'ln_id' => '<string>',
'sn_id' => '<string>',
'recruiter_id' => '<string>',
'ln_nickname' => '<string>',
'person_sid' => '<string>'
],
'attendees' => [
[
'ln_member_id' => '<string>',
'ln_id' => '<string>',
'sn_id' => '<string>',
'recruiter_id' => '<string>',
'ln_nickname' => '<string>',
'person_sid' => '<string>'
]
],
'title' => '<string>'
],
'reply_to_message_sid' => '<string>',
'subject' => '<string>',
'scheduled_at' => '<string>',
'agent_run_sid' => '<string>',
'attach_answer_sids' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Team-SID: <api-key>"
],
]);
$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://beta.getsales.io/unibox/v1/api/messages/send"
payload := strings.NewReader("{\n \"body\": \"<string>\",\n \"conversation_sid\": \"<string>\",\n \"new_thread\": {\n \"sender_profile_sid\": \"<string>\",\n \"to\": {\n \"email\": \"jsmith@example.com\",\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n },\n \"attendees\": [\n {\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n },\n \"reply_to_message_sid\": \"<string>\",\n \"subject\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"agent_run_sid\": \"<string>\",\n \"attach_answer_sids\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Team-SID", "<api-key>")
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://beta.getsales.io/unibox/v1/api/messages/send")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"body\": \"<string>\",\n \"conversation_sid\": \"<string>\",\n \"new_thread\": {\n \"sender_profile_sid\": \"<string>\",\n \"to\": {\n \"email\": \"jsmith@example.com\",\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n },\n \"attendees\": [\n {\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n },\n \"reply_to_message_sid\": \"<string>\",\n \"subject\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"agent_run_sid\": \"<string>\",\n \"attach_answer_sids\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/messages/send")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"body\": \"<string>\",\n \"conversation_sid\": \"<string>\",\n \"new_thread\": {\n \"sender_profile_sid\": \"<string>\",\n \"to\": {\n \"email\": \"jsmith@example.com\",\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n },\n \"attendees\": [\n {\n \"ln_member_id\": \"<string>\",\n \"ln_id\": \"<string>\",\n \"sn_id\": \"<string>\",\n \"recruiter_id\": \"<string>\",\n \"ln_nickname\": \"<string>\",\n \"person_sid\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n },\n \"reply_to_message_sid\": \"<string>\",\n \"subject\": \"<string>\",\n \"scheduled_at\": \"<string>\",\n \"agent_run_sid\": \"<string>\",\n \"attach_answer_sids\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "action",
"action": "<string>",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"conversation_sid": "<string>",
"channel": "linkedin",
"kind": "linkedin_message",
"direction": "inbound",
"state": "pending_approval",
"origin": "synced",
"body_text": "<string>",
"author": "contact",
"subject": "<string>",
"body_html": "<string>",
"approved_by_user_sid": "<string>",
"agent_run_sid": "<string>",
"ai_confidence": 123,
"ai_source": "<string>",
"workflow_task_sid": "<string>",
"automation_ref": {
"workflow_sid": "<string>",
"workflow_name": "<string>",
"step_id": 1,
"play_sid": "<string>",
"play_name": "<string>"
},
"provider_message_sid": "<string>",
"author_participant_sid": "<string>",
"reactions": [
{
"emoji": "<string>",
"count": 1,
"is_viewer_reacted": true,
"first_reacted_at": "<string>"
}
],
"attachments": [
{
"kind": "voice",
"state": "pending",
"name": "<string>",
"mime": "<string>",
"size": 1,
"pages": 1,
"is_inline": true,
"provider_attachment_id": "<string>",
"reason": "<string>",
"storage_key": "<string>",
"transcript": "<string>",
"transcript_state": "pending"
}
],
"is_wordless": true,
"failure_reason": "<string>",
"scheduled_at": "<string>",
"sent_at": "<string>",
"delivered_at": "<string>",
"opened_at": "<string>",
"clicked_at": "<string>",
"bounced_at": "<string>",
"recalled_at": "<string>",
"recalled_by_user_sid": "<string>",
"person_edited_at": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"result": {
"gate": "<string>",
"conversation": {
"sid": "<string>"
}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}{
"success": false,
"error": {
"code": "validation_failed",
"message": "<string>",
"recoverable": true,
"suggestion": "<string>",
"field_errors": {},
"blockers": [
{
"type": "<string>",
"severity": "hard",
"description": "<string>",
"entity_sid": "<string>",
"resolution": "<string>",
"resolution_hint": "<string>",
"count": 123
}
],
"context": {}
},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
}
}Authorizations
Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.
Team scope for tokens that do not carry one. Ignored when the token already names a team.
Body
application/json
Request body of send_message.
linkedin | email. It must be connected on the thread's sender profile, else 422 channel_not_connected.
Available options:
linkedin, email Must belong to channel: linkedin takes linkedin_message | linkedin_inmail | linkedin_connection_note, email takes email. A mismatch is 422.
Available options:
linkedin_message, linkedin_connection_note, linkedin_inmail, email The message text, min 1 char, plain text (email HTML composition is v1.5). NOTE the key: body here, body_text on update_message.
Minimum string length:
1Reply into this existing thread. Exactly one of conversation_sid | new_thread, else 422 invalid_input.
Required string length:
18Pattern:
^ub_cv_Start a thread instead: the sender profile plus the counterpart. The conversation is created with origin=native and comes back in result.conversation.
Show child attributes
Show child attributes
Quote this message of the thread under the reply (ub_ms_...); a reply into conversation_sid only, never with new_thread.
Required string length:
18Pattern:
^ub_ms_Email only, max 998. REQUIRED on an email new_thread (a reply inherits the thread subject); ignored on LinkedIn.
Maximum string length:
998ISO 8601 UTC. Holds the row in the queue until then; null = as soon as the per-sender-profile queue allows. The final gate still runs at that moment.
Provenance for an AGENT turn: the run that produced this text. Silently dropped for any non-agent actor. The dispatch gate and the dialog exchange meter key off it.
Required string length:
18Pattern:
^ub_rn_An AGENT turn only: the answers the run carried whose file goes out on request and the lead asked for (ub_an_ sids); the file goes with the message. A file that goes out every time needs no name. Ignored for other actors and answers the run did not carry.
Maximum array length:
5Required string length:
18Pattern:
^ub_an_Response
action success envelope.
Available options:
true Available options:
action kebab-case verb; matches the route segment.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes