> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a channel

> Partial patch. Only the supplied fields are changed.



## OpenAPI

````yaml https://api.neoagent.io/public-api/openapi.json patch /public-api/channels/{channel_id}
openapi: 3.1.0
info:
  description: >-
    Neo's public contract for the dashboard ChatAgent, partner integrations, and
    MSP automation. Every response is wrapped in a `{data, meta}` envelope;
    errors use `{error: {code, message, details?}, meta: {request_id}}`.
    Authenticate with a `Bearer neo_sk_<env>_<secret>` API key (service account)
    or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user
    feedback links) take a `signature` query parameter instead.
  title: Neo Public API
  version: 1.0.0
servers:
  - url: https://api.neoagent.io
security: []
tags:
  - description: Service metadata — health, OpenAPI.
    name: Meta
  - description: Agents and workflows — read, version history, delete, stats.
    name: Agents
  - description: Agent/workflow execution history, sub-resources, retry/cancel.
    name: Executions
  - description: PSA webhook events and their workflow-match results.
    name: Callbacks
  - description: Technician-in-the-loop approval requests.
    name: TIL requests
  - description: RMM script executions triggered by agents.
    name: RMM scripts
  - description: Dispatch-agent field-update decisions.
    name: Dispatch
  - description: The authenticated tenant.
    name: Tenant
  - description: Agent-builder schema catalogs (raw JSON payloads).
    name: Schemas
  - description: Escalate to the Neo team (HubSpot ticket).
    name: Escalation
  - description: Tenant settings.
    name: Settings
  - description: Tenant API-key management (dashboard JWT only).
    name: API keys
  - description: End-user feedback links (signed-URL auth).
    name: Feedback
  - description: End-client companies (CRUD + bulk-update).
    name: End companies
  - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams).
    name: Channels
  - description: PSA/RMM/M365 integration status and connection management.
    name: Integrations
  - description: Technician roster (controls TIL routing and paging).
    name: Technicians
  - description: Future runs queued for TRIGGERED agents.
    name: Scheduled work
  - description: Subscription state and customer-facing credit usage (no provider $).
    name: Billing
  - description: Inbox messages and announcements.
    name: Inbox & Comms
  - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog.
    name: Skills
paths:
  /public-api/channels/{channel_id}:
    patch:
      tags:
        - Channels
      summary: Update a channel
      description: Partial patch. Only the supplied fields are changed.
      operationId: public_api.channels_update_patch
      parameters:
        - in: path
          name: channel_id
          required: true
          schema:
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateChannelRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/PublicChannel'
                  meta:
                    $ref: '#/components/schemas/SuccessMeta'
                required:
                  - data
                  - meta
                type: object
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Bad request — malformed input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthenticated — missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden — authenticated but not allowed.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Conflict — the resource is in a state that blocks this operation.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Request validation failed.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited — see Retry-After.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    UpdateChannelRequest:
      properties:
        agent_id:
          anyOf:
            - type: integer
            - type: 'null'
          default: null
          title: Agent Id
        audience:
          anyOf:
            - $ref: '#/components/schemas/ToolAudience'
            - type: 'null'
          default: null
        color_icon_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Color Icon Url
        description:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Description
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Display Name
        internal_name:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Internal Name
        outline_icon_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Outline Icon Url
        relay_prefix:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Relay Prefix
        show_agent_progress_steps:
          anyOf:
            - type: boolean
            - type: 'null'
          default: null
          title: Show Agent Progress Steps
        status:
          anyOf:
            - $ref: '#/components/schemas/ChannelStatus'
            - type: 'null'
          default: null
        type:
          anyOf:
            - $ref: '#/components/schemas/ChannelType'
            - type: 'null'
          default: null
        welcome_message:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          title: Welcome Message
      title: UpdateChannelRequest
      type: object
    PublicChannel:
      description: >-
        A channel: a CONVERSATIONAL agent bound to a transport, plus its
        branding.
      properties:
        agent_id:
          anyOf:
            - type: integer
            - type: 'null'
          title: Agent Id
        audience:
          $ref: '#/components/schemas/ToolAudience'
        color_icon_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Color Icon Url
        created_at:
          format: date-time
          title: Created At
          type: string
        description:
          anyOf:
            - type: string
            - type: 'null'
          title: Description
        display_name:
          anyOf:
            - type: string
            - type: 'null'
          title: Display Name
        id:
          title: Id
          type: string
        internal_name:
          title: Internal Name
          type: string
        outline_icon_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Outline Icon Url
        relay_prefix:
          anyOf:
            - type: string
            - type: 'null'
          title: Relay Prefix
        show_agent_progress_steps:
          title: Show Agent Progress Steps
          type: boolean
        status:
          $ref: '#/components/schemas/ChannelStatus'
        type:
          $ref: '#/components/schemas/ChannelType'
        updated_at:
          format: date-time
          title: Updated At
          type: string
        welcome_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Welcome Message
      required:
        - id
        - internal_name
        - type
        - audience
        - agent_id
        - status
        - display_name
        - description
        - welcome_message
        - color_icon_url
        - outline_icon_url
        - show_agent_progress_steps
        - relay_prefix
        - created_at
        - updated_at
      title: PublicChannel
      type: object
    SuccessMeta:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        request_id:
          format: uuid
          type: string
        timings_ms:
          additionalProperties:
            type: number
          type: object
        warnings:
          description: >-
            Non-fatal warnings about the created/updated resource (e.g. an
            unhealthy PSA callback).
          items:
            type: string
          type: array
      required:
        - request_id
        - timings_ms
      type: object
    ErrorEnvelope:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable error code.
              type: string
            details:
              additionalProperties: true
              type: object
            message:
              type: string
          required:
            - code
            - message
          type: object
        meta:
          properties:
            request_id:
              format: uuid
              type:
                - string
                - 'null'
          type: object
      required:
        - error
        - meta
      type: object
    ToolAudience:
      description: >-
        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.
      enum:
        - MSP
        - END_USER
      title: ToolAudience
      type: string
    ChannelStatus:
      enum:
        - ACTIVE
        - DISCONNECTED
      title: ChannelStatus
      type: string
    ChannelType:
      description: >-
        Transport a channel binds an agent to. TEAMS is the only M2 transport;
        the rest are reserved.
      enum:
        - TEAMS
        - SLACK
        - PORTAL
        - EMAIL
      title: ChannelType
      type: string
    Pagination:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
  securitySchemes:
    bearerAuth:
      description: >-
        `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).
      scheme: bearer
      type: http

````