---
title: "Update a live channel"
method: PATCH
path: "/v2/sites/{site_id}/channels/{channel_id}/"
tags: ["live channels"]
---

# Update a live channel

`PATCH /v2/sites/{site_id}/channels/{channel_id}/`

Updates live channel metadata and settings, such as the content protection rule, DVR, latency, publishing mode, reconnect window, simulcast targets, and text tracks (captions, subtitles)

## Path parameters

- `site_id` string, required — Unique identifier for a resource
- `channel_id` string, required — Unique identifier for a resource

## Headers

- `Jw-Dry-Run` boolean

## Request body

- object
  - `metadata` LiveChannelResourceMetadata
    - `custom_params` CustomParamSchema — User-generated key-value pairs When defining `custom_params`, include all custom parameters that should be associated with the target resource. When updating existing `custom_params`, include all `custom_params` keys with their updated values. Any `custom_params` key-value pair not included within the updated `custom_params` in the request body is [deleted](https://docs.jwplayer.com/platform/docs/stream-faq-how-can-i-delete-a-custom-parameter).
    - `dvr` 'on' | 'off' — Enable or disable the DVR settings of the playback stream
    - `latency` 'default' | 'reduced' | 'low' — Type of latency for the live event stream, one of: * `default`: Delay from the video encoder to end-user’s player video is about 25 seconds. If your encoder has network issues it shas up to 30 seconds to reconnect before the event is automatically ended. * `reduced`: Delay from video encoder to end-user’s player is about 10 seconds. This is good for news and sports. The event will be automatically ended if your encoder has network issues and loses connectivity to the RTMP entry URL for any amount of time. Thus, your encoder should have a high-speed and reliable connection to the Internet. * `low`: This enables Low-Latency HLS (aka LL-HLS) streaming. Historically, HLS has favored stream reliability over latency. Low-Latency HLS extends the protocol to enable low-latency video streaming while maintaining scalability. Please note that LL-HLS is a fairly new extension of the protocol and 3rd party devices may not all support it at this moment. Low-Latency streaming does not currently support text tracks.
    - `publishing_mode` 'auto' | 'manual' — Defines how the events of a channel are made available to viewers * `auto`: When the encoder starts, viewers can watch the stream. * `manual`: When the encoder starts, viewers cannot watch the stream until the stream has been [published](/#operation/livestreamChannelEventPublish) from the JWX dashboard. In this publish mode, DVR **cannot** be enabled.
    - `reconnect_window` 5 | 60 | 300 — If the server does not receive any packets for a period of `reconnect_window` seconds, the server closes the connection.
    - `simulcast_targets` object[]
      - `stream_key` string
      - `stream_url` string — Ingest RTMP/s URL for the simulcast `simulcast_targets`
      - `title` string
    - `tags` string[]
    - `text_tracks` object[] — List of embedded text tracks (subtitles or closed captions) Only a single track is currently supported. **NOTE**: `text_tracks` with low latency is currently not supported.
      - `label` string — Label of the text track A maximum of 50 characters is permitted.
      - `srclang` string — Language of the text track data. Must be ISO 639-1 compliant
      - `track_kind` 'captions' | 'subtitles', required — Kind of text track
    - `title` string
  - `relationships` object
    - `protection_rule` RelationshipWrite
      - `id` string, required — Unique identifier for a resource

## Response `200`

Resource successfully updated

- LiveChannelResourceRead
  - `schema` string
  - `id` string — Unique identifier for a resource
  - `created` string — Date and time at which the resource was created
  - `last_modified` string — Date and time at which the resource was most recently modified
  - `type` string — Name of the type of resource.
  - `relationships` object — Ancilliary resources associated to the primary resource being read
    - `protection_rule` RelationshipRead
      - `id` string — Unique identifier for a resource
      - `type` string — Resource type
  - `metadata` LiveChannelResourceMetadata
    - `custom_params` CustomParamSchema — User-generated key-value pairs When defining `custom_params`, include all custom parameters that should be associated with the target resource. When updating existing `custom_params`, include all `custom_params` keys with their updated values. Any `custom_params` key-value pair not included within the updated `custom_params` in the request body is [deleted](https://docs.jwplayer.com/platform/docs/stream-faq-how-can-i-delete-a-custom-parameter).
    - `dvr` 'on' | 'off' — Enable or disable the DVR settings of the playback stream
    - `latency` 'default' | 'reduced' | 'low' — Type of latency for the live event stream, one of: * `default`: Delay from the video encoder to end-user’s player video is about 25 seconds. If your encoder has network issues it shas up to 30 seconds to reconnect before the event is automatically ended. * `reduced`: Delay from video encoder to end-user’s player is about 10 seconds. This is good for news and sports. The event will be automatically ended if your encoder has network issues and loses connectivity to the RTMP entry URL for any amount of time. Thus, your encoder should have a high-speed and reliable connection to the Internet. * `low`: This enables Low-Latency HLS (aka LL-HLS) streaming. Historically, HLS has favored stream reliability over latency. Low-Latency HLS extends the protocol to enable low-latency video streaming while maintaining scalability. Please note that LL-HLS is a fairly new extension of the protocol and 3rd party devices may not all support it at this moment. Low-Latency streaming does not currently support text tracks.
    - `publishing_mode` 'auto' | 'manual' — Defines how the events of a channel are made available to viewers * `auto`: When the encoder starts, viewers can watch the stream. * `manual`: When the encoder starts, viewers cannot watch the stream until the stream has been [published](/#operation/livestreamChannelEventPublish) from the JWX dashboard. In this publish mode, DVR **cannot** be enabled.
    - `reconnect_window` 5 | 60 | 300 — If the server does not receive any packets for a period of `reconnect_window` seconds, the server closes the connection.
    - `simulcast_targets` object[]
      - `stream_key` string
      - `stream_url` string — Ingest RTMP/s URL for the simulcast `simulcast_targets`
      - `title` string
    - `tags` string[]
    - `text_tracks` object[] — List of embedded text tracks (subtitles or closed captions) Only a single track is currently supported. **NOTE**: `text_tracks` with low latency is currently not supported.
      - `label` string — Label of the text track A maximum of 50 characters is permitted.
      - `srclang` string — Language of the text track data. Must be ISO 639-1 compliant
      - `track_kind` 'captions' | 'subtitles', required — Kind of text track
    - `title` string
  - `preview_url` string — URL pointing to a preview of the stream This is only present when channel has a `preview` status.
  - `recent_events` object[]
    - `media_id` string — Unique identifier for a resource
    - `status` 'active' | 'completed' | 'idle' | 'errored'
  - `status` 'creating' | 'active' | 'idle'
  - `stream_key` string

## Other responses

- `404` — Not Found The requested asset could not be found.
- `409` — Request conflicts with state of target resource

---

[API](https://skmtc.net/jwplayer/apis/management-api-v2.md) · [All operations](https://skmtc.net/jwplayer/apis/management-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/jwplayer/management-api-v2/versions/180db7cada27/schema)
