PATCH https://api.vidyard.com/dashboard/v1/organizations/:current_organization_id/live/:live_stream_instance_id DEPRECATED
Update/override stream instance options for organization with id.

Update stream instance options

Supported Formats

json

Errors

Code Description
400 Bad Request: body has wrong syntax or unable to handle request
401 Unauthorized: auth_token omitted or authentication failed
403 Forbidden: This action cannot be performed
404 Not Found: The requested resource could not be found
406 Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

Examples

REQUEST
PATCH /v1/organizations/15/live/153
Content-Type: application/json
{
  "description":"New Stream Description"
}

RESPONSE
200
{
  success: true
}

Params

Param name Description
auth_token
optional

API token needed to authorize requests
This can appear as an attribute in the body of the request or the query parameters on the URL

Validations:

  • Must be a String
name
optional

Stream name

Validations:

  • Must be a String
description
optional

Stream description

Validations:

  • Must be a String
dvr_enabled
optional

Whether the player controls are enabled for viewers

Validations:

  • Parameter has to be Boolean.
air_date
optional

The date/time the stream is set to air.

Validations:

  • Parameter has to be DateTime.
stream_tags
optional

Tags to describe video/stream

Validations:

  • Must be an array of any type