Skip to main content
PATCH
/
public-api
/
channels
/
{channel_id}
Update a channel
curl --request PATCH \
  --url https://api.neoagent.io/public-api/channels/{channel_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "agent_id": 123,
  "color_icon_url": "<string>",
  "description": "<string>",
  "display_name": "<string>",
  "internal_name": "<string>",
  "outline_icon_url": "<string>",
  "relay_prefix": "<string>",
  "show_agent_progress_steps": true,
  "welcome_message": "<string>"
}
'
import requests

url = "https://api.neoagent.io/public-api/channels/{channel_id}"

payload = {
    "agent_id": 123,
    "color_icon_url": "<string>",
    "description": "<string>",
    "display_name": "<string>",
    "internal_name": "<string>",
    "outline_icon_url": "<string>",
    "relay_prefix": "<string>",
    "show_agent_progress_steps": True,
    "welcome_message": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    agent_id: 123,
    color_icon_url: '<string>',
    description: '<string>',
    display_name: '<string>',
    internal_name: '<string>',
    outline_icon_url: '<string>',
    relay_prefix: '<string>',
    show_agent_progress_steps: true,
    welcome_message: '<string>'
  })
};

fetch('https://api.neoagent.io/public-api/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.neoagent.io/public-api/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([
    'agent_id' => 123,
    'color_icon_url' => '<string>',
    'description' => '<string>',
    'display_name' => '<string>',
    'internal_name' => '<string>',
    'outline_icon_url' => '<string>',
    'relay_prefix' => '<string>',
    'show_agent_progress_steps' => true,
    'welcome_message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.neoagent.io/public-api/channels/{channel_id}"

	payload := strings.NewReader("{\n  \"agent_id\": 123,\n  \"color_icon_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"internal_name\": \"<string>\",\n  \"outline_icon_url\": \"<string>\",\n  \"relay_prefix\": \"<string>\",\n  \"show_agent_progress_steps\": true,\n  \"welcome_message\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.neoagent.io/public-api/channels/{channel_id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"agent_id\": 123,\n  \"color_icon_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"internal_name\": \"<string>\",\n  \"outline_icon_url\": \"<string>\",\n  \"relay_prefix\": \"<string>\",\n  \"show_agent_progress_steps\": true,\n  \"welcome_message\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.neoagent.io/public-api/channels/{channel_id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"agent_id\": 123,\n  \"color_icon_url\": \"<string>\",\n  \"description\": \"<string>\",\n  \"display_name\": \"<string>\",\n  \"internal_name\": \"<string>\",\n  \"outline_icon_url\": \"<string>\",\n  \"relay_prefix\": \"<string>\",\n  \"show_agent_progress_steps\": true,\n  \"welcome_message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "agent_id": 123,
    "color_icon_url": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "display_name": "<string>",
    "id": "<string>",
    "internal_name": "<string>",
    "outline_icon_url": "<string>",
    "relay_prefix": "<string>",
    "show_agent_progress_steps": true,
    "updated_at": "2023-11-07T05:31:56Z",
    "welcome_message": "<string>"
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "timings_ms": {},
    "pagination": {
      "has_more": true,
      "next_cursor": "<string>"
    },
    "warnings": [
      "<string>"
    ]
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": {}
  },
  "meta": {
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

​
Authorization
string
header
required

Authorization: Bearer <token> where <token> is either a neo_sk_<env>_<secret> API key (service account) or a Microsoft Entra ID access token (dashboard user).

Path Parameters

​
channel_id
string
required

Body

application/json
​
agent_id
integer | null
​
audience
enum<string> | null

Trust domain a tool / agent / channel may be exposed to.

MSP — technician/dashboard surfaces; tools may take MSP-wide scope and accept company/ contact identifiers as LLM-supplied parameters. An agent/channel with this audience is the MSP's own INTERNAL surface (the dashboard labels MSP as "Internal"). END_USER — the MSP's end-client users (white-label Teams bots, embedded end-company chat). END_USER tools must derive ALL identity (end-company, contact) from the session context, never from tool parameters, so a prompt-injected or curious end user cannot widen scope. The two surfaces are disjoint by construction: resolve_end_user_toolbox resolves only END_USER tools (deny-by-default, no auto-injection), and resolve_full_toolbox is for MSP surfaces only.

Available options:
MSP,
END_USER
​
color_icon_url
string | null
​
description
string | null
​
display_name
string | null
​
internal_name
string | null
​
outline_icon_url
string | null
​
relay_prefix
string | null
​
show_agent_progress_steps
boolean | null
​
status
enum<string> | null
Available options:
ACTIVE,
DISCONNECTED
​
type
enum<string> | null

Transport a channel binds an agent to. TEAMS is the only M2 transport; the rest are reserved.

Available options:
TEAMS,
SLACK,
PORTAL,
EMAIL
​
welcome_message
string | null

Response

Success.

​
data
PublicChannel · object
required

A channel: a CONVERSATIONAL agent bound to a transport, plus its branding.

​
meta
object
required