---
title: "Update a channel by ID"
method: PATCH
path: "/channels/{id}"
tags: ["Channels"]
---

# Update a channel by ID

`PATCH /channels/{id}`

## Path parameters

- `id` string, required — Channel ID

## Request body

- UpdateChannelBody
  - `name` string — Name of the channel
  - `externalId` string — Deprecated, use 'externalIds' instead. Shorthand for a single-entry 'externalIds'. For now, responses will keep returning 'externalId' with the first entry of 'externalIds'.
  - `externalIds` string[] — External identifiers for the channel. Replaces the full list; an empty array clears all external IDs. Mutually exclusive with externalId.
  - `timeout` number — Timeout in seconds (minimum 60). To never stop, specify 0
  - `ads` object — OptiView Ads configuration. Only available when OptiView Ads is enabled for your organization.
    - `enabled` boolean, required — Whether OptiView ads are enabled on the channel
    - `customAssetKey` string — DAI asset key, only possible when Google is linked to your ads account
    - `timebase` 'wallclock' | 'pts' — Timebase for ad insertion. Defaults to "wallclock"
    - `settings` object — Deprecated. V1 ads settings.
      - `assetKey` string — Deprecated. Use customAssetKey instead.
      - `layout` 'SINGLE' | 'DOUBLE' | 'LSHAPE_AD' | 'LSHAPE_CONTENT'
      - `enableBumperAds` boolean
      - `podDuration` number
      - `customAdTagParameters` object
  - `dvr` object — DVR configuration. Only available when DVR feature is enabled for your organization.
    - `enabled` boolean, required — Whether DVR is enabled
    - `windowInSeconds` number — DVR window in seconds (60-86400)
  - `nielsen` object — Nielsen configuration. Only available when Nielsen feature is enabled for your organization.
    - `enabled` boolean, required — Whether Nielsen is enabled
  - `instreamMetadata` object — Instream metadata configuration
    - `enabled` boolean, required — Whether instream metadata is enabled. Supported metadata is h264 registered or unregistered SEI metadata
    - `uuids` string[] — Array of instream metadata SEI UUIDs

## Response `200`

Updated channel

- ChannelObjectResult
  - `data` object, required — Channel object
    - `id` string, required — Unique identifier of the channel
    - `createdAt` string, required — Creation timestamp
    - `name` string, required — Name of the channel
    - `status` 'ready' | 'stopped' | 'deploying' | 'starting' | 'waiting' | 'ingesting' | 'playing' | 'stopping' | 'error' | 'deleting' | 'deleted', required — Current status of the channel
    - `externalId` string — Deprecated, use 'externalIds' instead. For now, this returns the first entry of the 'externalIds' list.
    - `externalIds` string[] — External identifiers of the channel
    - `timeout` number, required — Timeout in seconds
    - `ads` object — OptiView Ads configuration
      - `enabled` boolean, required — Whether OptiView ads are enabled on the channel
      - `settings` object — Deprecated. Only returned for channels still using the old (V1) ads API underneath.
        - `assetKey` string — Deprecated. Use customAssetKey instead.
        - `layout` 'SINGLE' | 'DOUBLE' | 'LSHAPE_AD' | 'LSHAPE_CONTENT'
        - `enableBumperAds` boolean
        - `podDuration` number
        - `customAdTagParameters` object
    - `dvr` object — DVR configuration
      - `enabled` boolean, required — Whether DVR is enabled
      - `windowInSeconds` number — DVR window in seconds (60-86400)
    - `nielsen` object — Nielsen configuration
      - `enabled` boolean, required — Whether Nielsen is enabled
    - `instreamMetadata` object — Instream metadata configuration
      - `enabled` boolean, required — Whether instream metadata is enabled. Supported metadata is h264 registered or unregistered SEI metadata
      - `uuids` string[] — Array of instream metadata SEI UUIDs
    - `perpetual` boolean, required — Whether this channel is 24/7 (never times out, excluded from transcoding analytics)
    - `organizationId` string, required — Organization ID

---

[API](https://skmtc.net/dolby/apis/theolive-api.md) · [All operations](https://skmtc.net/dolby/apis/theolive-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/dolby/theolive-api/versions/b57006d43141/schema)