curl --request PATCH \
--url https://api.example.com/channels/{channel_id} \
--header 'Content-Type: application/json' \
--header 'x-user-id: <x-user-id>' \
--data '
{
"name": "<string>",
"platform_config": {},
"routing": {
"bindings": [
{
"agent_id": "<string>",
"match_key": "chat_id",
"match_value": "*",
"session_scope": "per_chat"
}
]
},
"session": {
"chat_model_config": {},
"fallback_chat_model_config": {},
"permission_mode": "default"
},
"enabled": true
}
'import requests
url = "https://api.example.com/channels/{channel_id}"
payload = {
"name": "<string>",
"platform_config": {},
"routing": { "bindings": [
{
"agent_id": "<string>",
"match_key": "chat_id",
"match_value": "*",
"session_scope": "per_chat"
}
] },
"session": {
"chat_model_config": {},
"fallback_chat_model_config": {},
"permission_mode": "default"
},
"enabled": True
}
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
platform_config: {},
routing: {
bindings: [
{
agent_id: '<string>',
match_key: 'chat_id',
match_value: '*',
session_scope: 'per_chat'
}
]
},
session: {
chat_model_config: {},
fallback_chat_model_config: {},
permission_mode: 'default'
},
enabled: true
})
};
fetch('https://api.example.com/channels/{channel_id}', 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.example.com/channels/{channel_id}",
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([
'name' => '<string>',
'platform_config' => [
],
'routing' => [
'bindings' => [
[
'agent_id' => '<string>',
'match_key' => 'chat_id',
'match_value' => '*',
'session_scope' => 'per_chat'
]
]
],
'session' => [
'chat_model_config' => [
],
'fallback_chat_model_config' => [
],
'permission_mode' => 'default'
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);
$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.example.com/channels/{channel_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"platform_config\": {},\n \"routing\": {\n \"bindings\": [\n {\n \"agent_id\": \"<string>\",\n \"match_key\": \"chat_id\",\n \"match_value\": \"*\",\n \"session_scope\": \"per_chat\"\n }\n ]\n },\n \"session\": {\n \"chat_model_config\": {},\n \"fallback_chat_model_config\": {},\n \"permission_mode\": \"default\"\n },\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-user-id", "<x-user-id>")
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://api.example.com/channels/{channel_id}")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"platform_config\": {},\n \"routing\": {\n \"bindings\": [\n {\n \"agent_id\": \"<string>\",\n \"match_key\": \"chat_id\",\n \"match_value\": \"*\",\n \"session_scope\": \"per_chat\"\n }\n ]\n },\n \"session\": {\n \"chat_model_config\": {},\n \"fallback_chat_model_config\": {},\n \"permission_mode\": \"default\"\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/channels/{channel_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"platform_config\": {},\n \"routing\": {\n \"bindings\": [\n {\n \"agent_id\": \"<string>\",\n \"match_key\": \"chat_id\",\n \"match_value\": \"*\",\n \"session_scope\": \"per_chat\"\n }\n ]\n },\n \"session\": {\n \"chat_model_config\": {},\n \"fallback_chat_model_config\": {},\n \"permission_mode\": \"default\"\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"channel_type": "<string>",
"name": "<string>",
"user_id": "<string>",
"platform_bot_id": "<string>",
"enabled": true,
"platform_config": {},
"routing": {
"bindings": [
{
"agent_id": "<string>",
"match_key": "chat_id",
"match_value": "*",
"session_scope": "per_chat"
}
]
},
"session": {
"chat_model_config": {},
"fallback_chat_model_config": {},
"permission_mode": "default"
},
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Update Channel
Update routing / session / config / enabled.
curl --request PATCH \
--url https://api.example.com/channels/{channel_id} \
--header 'Content-Type: application/json' \
--header 'x-user-id: <x-user-id>' \
--data '
{
"name": "<string>",
"platform_config": {},
"routing": {
"bindings": [
{
"agent_id": "<string>",
"match_key": "chat_id",
"match_value": "*",
"session_scope": "per_chat"
}
]
},
"session": {
"chat_model_config": {},
"fallback_chat_model_config": {},
"permission_mode": "default"
},
"enabled": true
}
'import requests
url = "https://api.example.com/channels/{channel_id}"
payload = {
"name": "<string>",
"platform_config": {},
"routing": { "bindings": [
{
"agent_id": "<string>",
"match_key": "chat_id",
"match_value": "*",
"session_scope": "per_chat"
}
] },
"session": {
"chat_model_config": {},
"fallback_chat_model_config": {},
"permission_mode": "default"
},
"enabled": True
}
headers = {
"x-user-id": "<x-user-id>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-user-id': '<x-user-id>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
platform_config: {},
routing: {
bindings: [
{
agent_id: '<string>',
match_key: 'chat_id',
match_value: '*',
session_scope: 'per_chat'
}
]
},
session: {
chat_model_config: {},
fallback_chat_model_config: {},
permission_mode: 'default'
},
enabled: true
})
};
fetch('https://api.example.com/channels/{channel_id}', 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.example.com/channels/{channel_id}",
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([
'name' => '<string>',
'platform_config' => [
],
'routing' => [
'bindings' => [
[
'agent_id' => '<string>',
'match_key' => 'chat_id',
'match_value' => '*',
'session_scope' => 'per_chat'
]
]
],
'session' => [
'chat_model_config' => [
],
'fallback_chat_model_config' => [
],
'permission_mode' => 'default'
],
'enabled' => true
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-user-id: <x-user-id>"
],
]);
$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.example.com/channels/{channel_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"platform_config\": {},\n \"routing\": {\n \"bindings\": [\n {\n \"agent_id\": \"<string>\",\n \"match_key\": \"chat_id\",\n \"match_value\": \"*\",\n \"session_scope\": \"per_chat\"\n }\n ]\n },\n \"session\": {\n \"chat_model_config\": {},\n \"fallback_chat_model_config\": {},\n \"permission_mode\": \"default\"\n },\n \"enabled\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-user-id", "<x-user-id>")
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://api.example.com/channels/{channel_id}")
.header("x-user-id", "<x-user-id>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"platform_config\": {},\n \"routing\": {\n \"bindings\": [\n {\n \"agent_id\": \"<string>\",\n \"match_key\": \"chat_id\",\n \"match_value\": \"*\",\n \"session_scope\": \"per_chat\"\n }\n ]\n },\n \"session\": {\n \"chat_model_config\": {},\n \"fallback_chat_model_config\": {},\n \"permission_mode\": \"default\"\n },\n \"enabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/channels/{channel_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-user-id"] = '<x-user-id>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"platform_config\": {},\n \"routing\": {\n \"bindings\": [\n {\n \"agent_id\": \"<string>\",\n \"match_key\": \"chat_id\",\n \"match_value\": \"*\",\n \"session_scope\": \"per_chat\"\n }\n ]\n },\n \"session\": {\n \"chat_model_config\": {},\n \"fallback_chat_model_config\": {},\n \"permission_mode\": \"default\"\n },\n \"enabled\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"channel_type": "<string>",
"name": "<string>",
"user_id": "<string>",
"platform_bot_id": "<string>",
"enabled": true,
"platform_config": {},
"routing": {
"bindings": [
{
"agent_id": "<string>",
"match_key": "chat_id",
"match_value": "*",
"session_scope": "per_chat"
}
]
},
"session": {
"chat_model_config": {},
"fallback_chat_model_config": {},
"permission_mode": "default"
},
"created_at": "<string>",
"updated_at": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Headers
Caller's user ID. Temporary header-based identity; will be replaced by JWT auth.
Path Parameters
Body
Request body for updating a channel (type/credentials immutable).
Ordered routing rules for a channel.
Validated so routing is always total and unambiguous: exactly one
catch-all, placed last, with no duplicate (match_key, match_value) pairs.
Show child attributes
Show child attributes
Settings applied when a channel creates an agent session.
Show child attributes
Show child attributes
Response
Successful Response
Channel details returned to the client (credentials omitted).
Ordered routing rules for a channel.
Validated so routing is always total and unambiguous: exactly one
catch-all, placed last, with no duplicate (match_key, match_value) pairs.
Show child attributes
Show child attributes
Settings applied when a channel creates an agent session.
Show child attributes
Show child attributes