---
title: "Update a channel"
method: PUT
path: "/channels/{channelId}"
tags: ["Channels"]
---

# Update a channel

`PUT /channels/{channelId}`

## Request

- Base URL: `https://api.superchat.com/v1.0`
- URL: `https://api.superchat.com/v1.0/channels/{channelId}`
- Auth: API key in header `X-API-KEY`

Moves a channel to an inbox in the same workspace. Moving a channel to its current inbox succeeds without changes.

## Path parameters

- `channelId` string, required

## Request body

- PAUpdateChannelDTO
  - `inbox_id` string, required: The ID of the inbox to move the channel to

## Response `200`

OK

- union
  - MESSAGECHANNELSMS
    - `id` string, required: The ID of the channel configuration
    - `inbox` PAInboxDTO, required
      - `id` string, required: The ID of the inbox
      - `name` string, required: The name of the inbox
      - `url` string: The URL of the inbox resource
    - `name` string, required: The display name of the channel
    - `phone_number` string, required: The phone number of the SMS channel
    - `type` 'sms', required
  - MESSAGECHANNELMAIL
    - `email_address` string, required: The email address of the mail channel
    - `id` string, required: The ID of the channel configuration
    - `inbox` PAInboxDTO, required
      - `id` string, required: The ID of the inbox
      - `name` string, required: The name of the inbox
      - `url` string: The URL of the inbox resource
    - `name` string, required: The display name of the channel
    - `type` 'mail', required
  - MESSAGECHANNELGOOGLEBUSINESSMESSAGING
    - `id` string, required: The ID of the channel configuration
    - `inbox` PAInboxDTO, required
      - `id` string, required: The ID of the inbox
      - `name` string, required: The name of the inbox
      - `url` string: The URL of the inbox resource
    - `name` string, required: The display name of the channel
    - `type` 'google_business_messaging', required
  - MESSAGECHANNELWHATSAPP
    - `id` string, required: The ID of the channel configuration
    - `inbox` PAInboxDTO, required
      - `id` string, required: The ID of the inbox
      - `name` string, required: The name of the inbox
      - `url` string: The URL of the inbox resource
    - `name` string, required: The display name of the channel
    - `phone_number` string, required: The phone number of the WhatsApp channel
    - `type` 'whats_app', required
    - `whats_app_business_account_id` string, required: The WhatsApp Business Account ID connected to the channel
  - MESSAGECHANNELFACEBOOKMESSENGER
    - `id` string, required: The ID of the channel configuration
    - `inbox` PAInboxDTO, required
      - `id` string, required: The ID of the inbox
      - `name` string, required: The name of the inbox
      - `url` string: The URL of the inbox resource
    - `name` string, required: The display name of the channel
    - `type` 'facebook_messenger', required
  - MESSAGECHANNELINSTAGRAM
    - `id` string, required: The ID of the channel configuration
    - `inbox` PAInboxDTO, required
      - `id` string, required: The ID of the inbox
      - `name` string, required: The name of the inbox
      - `url` string: The URL of the inbox resource
    - `name` string, required: The display name of the channel
    - `type` 'instagram', required
  - MESSAGECHANNELTELEGRAM
    - `id` string, required: The ID of the channel configuration
    - `inbox` PAInboxDTO, required
      - `id` string, required: The ID of the inbox
      - `name` string, required: The name of the inbox
      - `url` string: The URL of the inbox resource
    - `name` string, required: The display name of the channel
    - `type` 'telegram', required
  - MESSAGECHANNELLIVECHAT
    - `id` string, required: The ID of the channel configuration
    - `inbox` PAInboxDTO, required
      - `id` string, required: The ID of the inbox
      - `name` string, required: The name of the inbox
      - `url` string: The URL of the inbox resource
    - `name` string, required: The display name of the channel
    - `type` 'live_chat', required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

## Changes

- **2026-11-03** `31e7bd6f37e9`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/superchat/apis/superchat-api/changes/channels/:channelId/put.md)

---

[API](https://skmtc.dev/superchat/apis/superchat-api.md) - [All operations](https://skmtc.dev/superchat/apis/superchat-api/llms.txt) - [OpenAPI document](https://skmtc.dev/superchat/apis/superchat-api/revisions/31e7bd6f37e9?raw)