PATCH https://api.vidyard.com/dashboard/v1/players/uuid=:uuid
Update a player by UUID

Also see "PATCH Player" for examples.

Update a player

IMPORTANT CHANGE TO ENDPOINT: The following parameters in this endpoint can now only be used if player_type = playlist - “playlist_always_open”, “on_complete”, “redirect_url”, “redirect_whole_page”, “up_next”

MOVING A PLAYER: Provide an organization_id to move the player and its attached video into a different folder within the same account. See the “PATCH Player” examples.

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

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
uuid
required

Validations:

  • Must be a String
organization_id
optional , nil allowed

Move the player and its attached video to a different folder within the same account. Set this to the id of the destination folder’s organization.
The destination folder must belong to the same account, and you must be able to edit players in the current folder and create players in the destination folder.
The player, its chapters, attached video and tags are moved to the destination folder (the move is processed asynchronously).
Default: the player’s current organization (no move)

Validations:

  • Parameter has to be Integer.