Channels for Organization

Update Desired State

Update Channel DesiredState to ON/OFF

put/v2/{org}/channels/{channel-id}/desired-state

Request

  • Base URL: https://api.istreamplanet.com
  • URL: https://api.istreamplanet.com/v2/{org}/channels/{channel-id}/desired-state
  • Auth: authcode (defined in the document in a form this page cannot read) and m2m (defined in the document in a form this page cannot read)

Path parameters

orgstring required

Organization name

channel-idstring required

Unique channel identifier

Query parameters

end_playlistboolean

Deprecated, server ignores all values. Will be removed from API once all clients are confirmed to not break.

Headers

If-Matchstring[] nullable

Succeeds if the server's resource matches one of the passed values.

If-None-Matchstring[] nullable

Succeeds if the server's resource matches none of the passed values. On writes, the special value * may be used to match any existing value.

If-Modified-Sincestring date-time-http

Succeeds if the server's resource date is more recent than the passed date.

If-Unmodified-Sincestring date-time-http

Succeeds if the server's resource date is older or the same as the passed date.

Request body

$schemastring uri

A URL to the JSON Schema for this object.

desired_state'ON' | 'OFF' required

Desired state

Example request

{
  "$schema": "https://api.istreamplanet.com/schemas/DesiredStateRequestBody.json",
  "desired_state": "ON"
}

Response

No Content

Changes

No recorded changes to this operation across all 1 revision of this API.