PUT https://api.vidyard.com/dashboard/v1/chapters/:id
Updates a single chapter

Updates a single chapter.

IMPORTANT CHANGE TO ENDPOINT: This endpoint should only be used with an existing player where the player_type equals playlist. You should also only use this endpoint to change the position of the video in the player object. Changes to either the player_id or video_id may result in unexpected behavior.

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
422	Unprocessable Entity: body has wrong attributes

Examples

REQUEST
Content-Type: application/json
{
  "id": 500,
  "player_id": 1085,
  "position": 1,
  "video_id": 20234
}

RESPONSE
200 (OK)
{
  "id": 500,
  "player_id": 1085,
  "position": 1,
  "video_id": 20234
  "created_at": 1346961610,
  "updated_at": 1346961610
}

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
position optional	The position this chapter appears in the player Zero based index eg. “0” would be “Chapter 1” Validations: Parameter has to be Integer.
player_id optional	The player the chapter will be added to Validations: Parameter has to be Integer.
video_id optional	The id of the video the chapter will contain Validations: Parameter has to be Integer.