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

# Update a channel

`PUT /distchannels/{channelId}`

## Request

- Base URL: `https://api.smartthings.com/v1`
- URL: `https://api.smartthings.com/v1/distchannels/{channelId}`
- Auth: OAuth 2
  - Implicit: `https://auth-global.api.smartthings.com`
  - Scopes: `w:channels:*`
- TypeScript: <https://skmtc.dev/smartthings/apis/smartthings-api/docs/distchannels/:channelId/put.ts> (a function with typed inputs; its response is checked against the schema)

Update a channel by channel ID

## Headers

- `Authorization` string, string, required

## Request body

- PatchChannel
  - `name` string: Name of the channel
  - `description` string: Description of the channel
  - `termsOfServiceUrl` string: URL for a developer-provided Terms of Service agreement for the channel

## Response `200`

Channel details

- DetailedChannel
  - `channelId` string, uuid: The identifier of the Sprocket channel
  - `name` string: Name of the channel
  - `description` string: Description of the channel
  - `type` 'DRIVER': The type of channel
  - `termsOfServiceUrl` string: URL for a developer-provided Terms of Service agreement for the channel
  - `createdDate` string: The ISO-8601 formatted timestamp when the channel was created
  - `lastModifiedDate` string: The ISO-8601 formatted timestamp when the channel was last modified

## Changes

- **2025-02-11** `32f2af0e7ed1`: 1 info
  - endpoint added

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

---

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