Cancel messages that have not gone out
curl --request POST \
--url https://beta.getsales.io/unibox/v1/api/messages/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"sid": "<string>",
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"conversation_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"channel": {
"in": []
},
"kind": {
"in": []
},
"direction": {},
"state": {
"in": [],
"nin": []
},
"author": {
"in": []
},
"origin": {},
"sent_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"is_null": true
}
}
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/messages/cancel"
payload = {
"sid": "<string>",
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"conversation_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"channel": { "in": [] },
"kind": { "in": [] },
"direction": {},
"state": {
"in": [],
"nin": []
},
"author": { "in": [] },
"origin": {},
"sent_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": { "is_null": True }
}
}
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({
sid: '<string>',
filter: {
sid: {eq: '<string>', in: ['<string>']},
conversation_sid: {eq: '<string>', in: ['<string>']},
channel: {in: []},
kind: {in: []},
direction: {},
state: {in: [], nin: []},
author: {in: []},
origin: {},
sent_at: {gte: '<string>', lte: '<string>', is_null: true},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
deleted_at: {is_null: true}
}
})
};
fetch('https://beta.getsales.io/unibox/v1/api/messages/cancel', 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/cancel",
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([
'sid' => '<string>',
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'conversation_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'channel' => [
'in' => [
]
],
'kind' => [
'in' => [
]
],
'direction' => [
],
'state' => [
'in' => [
],
'nin' => [
]
],
'author' => [
'in' => [
]
],
'origin' => [
],
'sent_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'deleted_at' => [
'is_null' => true
]
]
]),
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/cancel"
payload := strings.NewReader("{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"conversation_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"kind\": {\n \"in\": []\n },\n \"direction\": {},\n \"state\": {\n \"in\": [],\n \"nin\": []\n },\n \"author\": {\n \"in\": []\n },\n \"origin\": {},\n \"sent_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"is_null\": true\n }\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/cancel")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"conversation_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"kind\": {\n \"in\": []\n },\n \"direction\": {},\n \"state\": {\n \"in\": [],\n \"nin\": []\n },\n \"author\": {\n \"in\": []\n },\n \"origin\": {},\n \"sent_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"is_null\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/messages/cancel")
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 \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"conversation_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"kind\": {\n \"in\": []\n },\n \"direction\": {},\n \"state\": {\n \"in\": [],\n \"nin\": []\n },\n \"author\": {\n \"in\": []\n },\n \"origin\": {},\n \"sent_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"is_null\": true\n }\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": {
"canceled_count": 1,
"in_flight_count": 1
},
"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
Cancel messages that have not gone out
Cancel a message that has not gone out: a failed send, or a queued one the provider has not taken yet, is canceled and leaves the thread. Nothing is sent or deleted: the row stays. A draft awaiting approval is dismiss_messages; a row that went out is 409 message_not_cancelable; one being handed to the provider right now is 409 message_send_in_flight. An AI SDR message of a live plan cancels that plan with its other unsent messages.
Contract:
- MCP tool
cancel_messages, 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; mass action: this verb’s own request accepts a filter or targets[] set, which the owning service drains.
POST
/
api
/
messages
/
cancel
Cancel messages that have not gone out
curl --request POST \
--url https://beta.getsales.io/unibox/v1/api/messages/cancel \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"sid": "<string>",
"filter": {
"sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"conversation_sid": {
"eq": "<string>",
"in": [
"<string>"
]
},
"channel": {
"in": []
},
"kind": {
"in": []
},
"direction": {},
"state": {
"in": [],
"nin": []
},
"author": {
"in": []
},
"origin": {},
"sent_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": true
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": {
"is_null": true
}
}
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/messages/cancel"
payload = {
"sid": "<string>",
"filter": {
"sid": {
"eq": "<string>",
"in": ["<string>"]
},
"conversation_sid": {
"eq": "<string>",
"in": ["<string>"]
},
"channel": { "in": [] },
"kind": { "in": [] },
"direction": {},
"state": {
"in": [],
"nin": []
},
"author": { "in": [] },
"origin": {},
"sent_at": {
"gte": "<string>",
"lte": "<string>",
"is_null": True
},
"created_at": {
"gte": "<string>",
"lte": "<string>",
"gt": "<string>",
"lt": "<string>"
},
"deleted_at": { "is_null": True }
}
}
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({
sid: '<string>',
filter: {
sid: {eq: '<string>', in: ['<string>']},
conversation_sid: {eq: '<string>', in: ['<string>']},
channel: {in: []},
kind: {in: []},
direction: {},
state: {in: [], nin: []},
author: {in: []},
origin: {},
sent_at: {gte: '<string>', lte: '<string>', is_null: true},
created_at: {gte: '<string>', lte: '<string>', gt: '<string>', lt: '<string>'},
deleted_at: {is_null: true}
}
})
};
fetch('https://beta.getsales.io/unibox/v1/api/messages/cancel', 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/cancel",
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([
'sid' => '<string>',
'filter' => [
'sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'conversation_sid' => [
'eq' => '<string>',
'in' => [
'<string>'
]
],
'channel' => [
'in' => [
]
],
'kind' => [
'in' => [
]
],
'direction' => [
],
'state' => [
'in' => [
],
'nin' => [
]
],
'author' => [
'in' => [
]
],
'origin' => [
],
'sent_at' => [
'gte' => '<string>',
'lte' => '<string>',
'is_null' => true
],
'created_at' => [
'gte' => '<string>',
'lte' => '<string>',
'gt' => '<string>',
'lt' => '<string>'
],
'deleted_at' => [
'is_null' => true
]
]
]),
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/cancel"
payload := strings.NewReader("{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"conversation_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"kind\": {\n \"in\": []\n },\n \"direction\": {},\n \"state\": {\n \"in\": [],\n \"nin\": []\n },\n \"author\": {\n \"in\": []\n },\n \"origin\": {},\n \"sent_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"is_null\": true\n }\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/cancel")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"conversation_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"kind\": {\n \"in\": []\n },\n \"direction\": {},\n \"state\": {\n \"in\": [],\n \"nin\": []\n },\n \"author\": {\n \"in\": []\n },\n \"origin\": {},\n \"sent_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"is_null\": true\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/messages/cancel")
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 \"sid\": \"<string>\",\n \"filter\": {\n \"sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"conversation_sid\": {\n \"eq\": \"<string>\",\n \"in\": [\n \"<string>\"\n ]\n },\n \"channel\": {\n \"in\": []\n },\n \"kind\": {\n \"in\": []\n },\n \"direction\": {},\n \"state\": {\n \"in\": [],\n \"nin\": []\n },\n \"author\": {\n \"in\": []\n },\n \"origin\": {},\n \"sent_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"is_null\": true\n },\n \"created_at\": {\n \"gte\": \"<string>\",\n \"lte\": \"<string>\",\n \"gt\": \"<string>\",\n \"lt\": \"<string>\"\n },\n \"deleted_at\": {\n \"is_null\": true\n }\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": {
"canceled_count": 1,
"in_flight_count": 1
},
"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 cancel_messages.
One message that has not gone out (failed, or queued and not taken by the provider yet) to cancel. Exactly one of sid | filter, else 422 invalid_input.
Required string length:
18Pattern:
^ub_ms_Fan-out arm: cancel every matching message that has not gone out (the backend ANDs state in [failed, queued] in), so { conversation_sid: { eq } } cancels everything still waiting on one thread.
Show child attributes
Show child attributes
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