Update agent scenario
curl --request PATCH \
--url https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"agent_sid": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"steps": [
{
"id": "<string>",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"conditions": [
{
"when": "<string>"
}
]
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}"
payload = {
"agent_sid": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"steps": [
{
"id": "<string>",
"enabled": True,
"locked": True,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"conditions": [{ "when": "<string>" }]
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
agent_sid: '<string>',
title: '<string>',
trigger: '<string>',
context: '<string>',
steps: [
{
id: '<string>',
enabled: true,
locked: true,
when: '<string>',
instructions: '<string>',
params: {}
}
],
conditions: [{when: '<string>'}]
})
};
fetch('https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}', 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/agent-scenarios/{sid}",
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([
'agent_sid' => '<string>',
'title' => '<string>',
'trigger' => '<string>',
'context' => '<string>',
'steps' => [
[
'id' => '<string>',
'enabled' => true,
'locked' => true,
'when' => '<string>',
'instructions' => '<string>',
'params' => [
]
]
],
'conditions' => [
[
'when' => '<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/agent-scenarios/{sid}"
payload := strings.NewReader("{\n \"agent_sid\": \"<string>\",\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_sid\": \"<string>\",\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_sid\": \"<string>\",\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "update",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"agent_sid": "<string>",
"scenario_key": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"context_compact": "<string>",
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"steps_base_version": 123,
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
],
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"match_count": 1,
"last_matched_at": "<string>",
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"source": "platform",
"seed": {
"version": 123,
"title": "<string>",
"trigger": "<string>",
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
]
},
"playbook": {
"source": "platform",
"key": "<string>",
"version": 123,
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"instructions": "<string>",
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
]
},
"default_changed": true
},
"updated_fields": [
"<string>"
],
"previous_values": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"kept_fields": [
"<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>"
}
}agent_scenarios
Update agent scenario
Edit a scenario: by sid (a row of the team’s), or by platform key (the first edit bears the team’s row). The steps (the list replaced whole: switch one off, reorder, delete, add, reword a step’s instructions, its when, its parameters), the instructions over them (context), the level with its conditions (autopilot, copilot, conditional, off); a team’s own scenario also its title and trigger. A locked step stays on as it is; a parameter outside its dictionary is a 422.
Contract:
- MCP tool
update_agent_scenario, registry packagemcp.unibox/agent_scenarios, mountunibox.agent. - Operation
update, response envelopeupdate. - Flags: none.
PATCH
/
api
/
agent-scenarios
/
{sid}
Update agent scenario
curl --request PATCH \
--url https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Team-SID: <api-key>' \
--data '
{
"agent_sid": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"steps": [
{
"id": "<string>",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"conditions": [
{
"when": "<string>"
}
]
}
'import requests
url = "https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}"
payload = {
"agent_sid": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"steps": [
{
"id": "<string>",
"enabled": True,
"locked": True,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"conditions": [{ "when": "<string>" }]
}
headers = {
"Authorization": "Bearer <token>",
"Team-SID": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
Authorization: 'Bearer <token>',
'Team-SID': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
agent_sid: '<string>',
title: '<string>',
trigger: '<string>',
context: '<string>',
steps: [
{
id: '<string>',
enabled: true,
locked: true,
when: '<string>',
instructions: '<string>',
params: {}
}
],
conditions: [{when: '<string>'}]
})
};
fetch('https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}', 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/agent-scenarios/{sid}",
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([
'agent_sid' => '<string>',
'title' => '<string>',
'trigger' => '<string>',
'context' => '<string>',
'steps' => [
[
'id' => '<string>',
'enabled' => true,
'locked' => true,
'when' => '<string>',
'instructions' => '<string>',
'params' => [
]
]
],
'conditions' => [
[
'when' => '<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/agent-scenarios/{sid}"
payload := strings.NewReader("{\n \"agent_sid\": \"<string>\",\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}")
.header("Authorization", "Bearer <token>")
.header("Team-SID", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"agent_sid\": \"<string>\",\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://beta.getsales.io/unibox/v1/api/agent-scenarios/{sid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Team-SID"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"agent_sid\": \"<string>\",\n \"title\": \"<string>\",\n \"trigger\": \"<string>\",\n \"context\": \"<string>\",\n \"steps\": [\n {\n \"id\": \"<string>\",\n \"enabled\": true,\n \"locked\": true,\n \"when\": \"<string>\",\n \"instructions\": \"<string>\",\n \"params\": {}\n }\n ],\n \"conditions\": [\n {\n \"when\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"operation": "update",
"item": {
"sid": "<string>",
"team_sid": "<string>",
"agent_sid": "<string>",
"scenario_key": "<string>",
"title": "<string>",
"trigger": "<string>",
"context": "<string>",
"context_compact": "<string>",
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"steps_base_version": 123,
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
],
"created_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"match_count": 1,
"last_matched_at": "<string>",
"deleted_by": {
"actor_type": "user",
"actor_sid": "<string>",
"team_sid": "<string>",
"permissions": {},
"actor_name": "<string>",
"oauth_client_sid": "<string>",
"reason": "<string>",
"cluster_id": 123,
"trace_id": "<string>"
},
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"source": "platform",
"seed": {
"version": 123,
"title": "<string>",
"trigger": "<string>",
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
]
},
"playbook": {
"source": "platform",
"key": "<string>",
"version": 123,
"goal": "<string>",
"max_steps": 123,
"steps": [
{
"id": "<string>",
"kind": "react",
"enabled": true,
"locked": true,
"when": "<string>",
"instructions": "<string>",
"params": {}
}
],
"instructions": "<string>",
"level": "autopilot",
"conditions": [
{
"kind": "lead",
"when": "<string>",
"then": "copilot"
}
]
},
"default_changed": true
},
"updated_fields": [
"<string>"
],
"previous_values": {},
"meta": {
"trace_id": "<string>",
"span_id": "<string>",
"timestamp": "<string>",
"duration_ms": 1,
"team_sid": "<string>",
"actor_type": "<string>"
},
"kept_fields": [
"<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.
Path Parameters
ub_sc_ sid or key: interested, meeting_request, info_request, referral, not_now, out_of_office, auto_reply, wrong_person, reschedule_request, cancel_request, other_low_signal, not_interested, objection, do_not_contact, followup_no_reply, signal_followup.
Required string length:
1 - 64Body
application/json
Request body of update_agent_scenario.
The AI SDR whose scenario it is (ub_ag_…); with a platform key, which agent's version. Left out, the team's default agent.
Required string length:
18Pattern:
^ub_ag_The team's own scenario only: a platform scenario's name is the platform's (422).
Required string length:
1 - 255The team's own scenario only (422 on a platform scenario).
Required string length:
1 - 2048The instructions over the playbook; null clears them.
Maximum string length:
32768FULL-REPLACE of the step list: on a platform scenario the fork (null drops it, the seed applies again; a locked step stays on, as it is); on the team's own scenario its steps.
Maximum array length:
16Show child attributes
Show child attributes
The level: autopilot, copilot, conditional (with conditions) or off. On a platform key the first edit bears the team's row; reset_agent_scenario puts the seed's level back.
Available options:
autopilot, copilot, conditional, off FULL-REPLACE of a Conditional level's conditions, in order (at most 6); null clears them. Read on every reply: the first that holds decides, Autopilot otherwise.
Maximum array length:
6Show child attributes
Show child attributes
Response
update success envelope.
Available options:
true Available options:
update Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.