Infomaniak Vod icon

Infomaniak Vod

Interact with Infomaniak Vod API

Actions349

V3 > Player → Update Player Details.

AI-generated

Summary

Update the details of a specified Player by its unique identifier, modifying any provided properties such as appearance, controls, playback behavior, and sharing options.

Inputs

  • authentication — Select the authentication method to use; either OAuth2 or API Key.
  • path_player (required) — The unique identifier of the Player to update.
  • bodyParameters — Optional fields to update on the Player, including settings like ads category, audio volume, control colors, playback preferences, sharing capabilities, logo settings, dimensions, theme, and more. Each field corresponds to a specific Player attribute to customize.
  • returnFullResponse — Boolean flag to specify if the operation should return the full HTTP response instead of just the updated Player data.

Output shape

a single updated Player record

Returns the updated Player object with the fields that were changed. Can return the full HTTP response if 'Return Full Response' is set to true.

Examples

Example 1: Update the Player's name, enable autoplay, and set a custom control color.

Provide the Player ID, and in 'Additional Body Fields', set 'Name' to the new name, 'Auto Start' to true, and 'Control Color' to the desired color string.

Links

Discussion