Channels

Update a channel

Update a channel by channel ID

put/distchannels/{channelId}

Request

Base URL
https://api.smartthings.com/v1
Auth
OAuth 2
Implicithttps://auth-global.api.smartthings.com
Scopesw: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.

Authorizationstring string required

OAuth token

namestring

Name of the channel

descriptionstring

Description of the channel

termsOfServiceUrlstring

URL for a developer-provided Terms of Service agreement for the channel

Channel details

channelIdstring uuid

The identifier of the Sprocket channel

namestring

Name of the channel

descriptionstring

Description of the channel

type'DRIVER'

The type of channel

termsOfServiceUrlstring

URL for a developer-provided Terms of Service agreement for the channel

createdDatestring

The ISO-8601 formatted timestamp when the channel was created

lastModifiedDatestring

The ISO-8601 formatted timestamp when the channel was last modified

{
  "channelId": "9314a926-528c-403f-ae56-4b0d059381dd"
}