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>"
}
'
{
  "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>"
    ]
  }
}

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