---
title: "POST /channels/{channelID}"
method: POST
path: "/channels/{channelID}"
tags: ["channels"]
---

# POST /channels/{channelID}

`POST /channels/{channelID}`

Edit a channel. All fields are optional, only fields that are provided will be changed.

## Path parameters

- `channelID` string, uuid, required

## Request body

- object
  - `name` string
  - `description` string
  - `restrictedTo` object, nullable — An object describing who can access this channel. If set to null, then the channel will be public.
    - `invitedUsers` string[] — A list of emails corresponding to the users that can access this channel. If the channel is private, only these users will be able to access the channel. If both invitedUsers & invitedGroups are provided, the lists will be combined.
    - `invitedGroups` string[] — If the channel is private, only these groups will be able to access the channel. If both invitedUsers & invitedGroups are provided, the lists will be combined.
  - `isReadOnly` boolean — If true, only admins & moderators will be able to create threads in this channel. This option is not currently available for chat channels

## Response `200`

Successful response

## Other responses

- `400` — Invalid request body
- `401` — API Key is missing or invalid

---

[API](https://skmtc.net/heartbeat/apis/heartbeat-api.md) · [All operations](https://skmtc.net/heartbeat/apis/heartbeat-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heartbeat/heartbeat-api/revisions/6c3cf537d508/schema)