Time	Status	User Agent
Retrieving recent requests…

Time

Status

User Agent

Retrieving recent requests…

POST /player

Configure the default player settings for the organization, including visible controls, colors, captions, save progress behavior, branding, tracking pixels, and settings menu options.

📘
Authorization
This endpoint requires a valid Panda API token sent in the Authorization header (without the Bearer prefix). The configuration applies to the authenticated organization and updates the default player settings used across its videos.

HTTP Method & Path

POST /player

Base URL: https://api-v2.pandavideo.com.br

Authentication Requirements

Security Scheme: PandaAuth (apiKey)
Header: Authorization: <your_api_token> (no Bearer prefix)

Parameters

Name	In	Type	Required	Description
`Authorization`	header	string	Yes	Panda API token (without Bearer prefix)

Request Body

Content-Type: application/json

Body Parameters

Field	Type	Required	Description	Constraints
`controls`	array of strings	Yes	Controls displayed in the player	Allowed values: `play-large`, `rewind`, `play`, `fast-forward`, `current-time`, `volume`, `captions`, `settings`, `pip`, `fullscreen`, `airplay`, `cast`
`primaryColor`	string	Yes	Main accent color of the player	Hex color (e.g., `#4874F1`)
`controlsColor`	string	Yes	Color of the player controls	Hex color (e.g., `#FFFFFF`)
`captionsColor`	string	Yes	Color of the captions text	Hex color (e.g., `#FFFFFF`)
`captionsBackgroundColor`	string	Yes	Background color behind the captions text	Hex color (e.g., `#000000`)
`captionsFontSize`	integer	Yes	Captions font size in pixels	Integer, > 0
`saveProgress`	boolean	Yes	Whether to save the viewer's playback progress and resume from the last position	—
`pandaBranding`	boolean	Yes	Whether to display the Panda Video branding in the player	—
`defaultLanguage`	string	Yes	Default subtitle language to enable when the video starts	BCP 47 code (e.g., `pt-br`); use `""` for none
`timeDisplayType`	string	Yes	Time display mode in the player	Enum: `CURRENT_TOTAL_TIME`, `REMAINING_TIME`
`refCode`	string	Yes	Reference code used for tracking and attribution	Use `""` if not used
`settingsControls`	object	Yes	Toggles for items shown in the player's settings menu	See sub-fields below
`settingsControls.speed`	boolean	Yes	Show the playback speed option in the settings menu	—
`settingsControls.quality`	boolean	Yes	Show the quality (resolution) option in the settings menu	—
`settingsControls.dubbing`	boolean	Yes	Show the dubbing/audio-track option in the settings menu	—
`settingsControls.captionsLanguage`	boolean	Yes	Show the captions language option in the settings menu	—
`fbPixel`	array of strings	Yes	Facebook Pixel IDs to fire from the player	Use `[]` for none
`gtagIds`	array of strings	Yes	Google Tag IDs to fire from the player	Use `[]` for none

Example Request Body

{
  "controls": ["play-large", "rewind", "play", "fast-forward", "current-time", "volume", "captions", "settings", "pip", "fullscreen", "airplay", "cast"],
  "primaryColor": "#4874F1",
  "controlsColor": "#FFFFFF",
  "captionsColor": "#FFFFFF",
  "captionsBackgroundColor": "#000000",
  "captionsFontSize": 14,
  "saveProgress": false,
  "pandaBranding": true,
  "defaultLanguage": "",
  "timeDisplayType": "CURRENT_TOTAL_TIME",
  "refCode": "",
  "settingsControls": {
    "speed": true,
    "quality": true,
    "dubbing": true,
    "captionsLanguage": true
  },
  "fbPixel": ["124514141"],
  "gtagIds": []
}

Response

Success Response (200)

Returns the full player configuration after the update:

{
  "config": {
    "controls": ["play-large", "rewind", "play", "fast-forward", "current-time", "volume", "captions", "settings", "pip", "fullscreen", "airplay", "cast"],
    "captionsBackgroundColor": "#000000",
    "captionsFontSize": 14,
    "primaryColor": "#4874F1",
    "captionsColor": "#FFFFFF",
    "menuColor": "#4a5464",
    "controlsColor": "#FFFFFF",
    "saveProgress": false,
    "fbPixel": ["124514141"],
    "gtagIds": [],
    "pandaBranding": true,
    "refCode": "",
    "defaultLanguage": "",
    "timeDisplayType": "CURRENT_TOTAL_TIME",
    "settingsControls": {
      "speed": true,
      "quality": true,
      "dubbing": true,
      "captionsLanguage": true
    }
  }
}

Response Schema

Field	Type	Description
`config`	object	Full player configuration object
`config.controls`	array of strings	Controls displayed in the player
`config.primaryColor`	string	Main accent color of the player (hex)
`config.controlsColor`	string	Color of the player controls (hex)
`config.captionsColor`	string	Color of the captions text (hex)
`config.captionsBackgroundColor`	string	Background color behind the captions text (hex)
`config.captionsFontSize`	integer	Captions font size in pixels
`config.menuColor`	string	Settings menu color (hex). Returned by the server; defaults to `#4a5464`
`config.saveProgress`	boolean	Whether playback progress is saved
`config.pandaBranding`	boolean	Whether the Panda Video branding is displayed
`config.defaultLanguage`	string	Default subtitle language (BCP 47); empty string when none
`config.timeDisplayType`	string	Time display mode: `CURRENT_TOTAL_TIME` or `REMAINING_TIME`
`config.refCode`	string	Reference code used for tracking; empty string when unused
`config.settingsControls`	object	Toggles for the items shown in the settings menu
`config.settingsControls.speed`	boolean	Whether the playback speed option is shown
`config.settingsControls.quality`	boolean	Whether the quality option is shown
`config.settingsControls.dubbing`	boolean	Whether the dubbing/audio-track option is shown
`config.settingsControls.captionsLanguage`	boolean	Whether the captions language option is shown
`config.fbPixel`	array of strings	Facebook Pixel IDs configured on the player
`config.gtagIds`	array of strings	Google Tag IDs configured on the player

Error Responses

401 Unauthorized: Missing or invalid API token
403 Forbidden: The authenticated account is not allowed to update the player configuration
422 Unprocessable Entity: Invalid body fields (e.g., unknown control, malformed hex color, invalid enum value)
500 Internal Server Error: Server-side error

Example Usage

cURL

curl -X POST \
  'https://api-v2.pandavideo.com.br/player' \
  -H 'Authorization: your_api_token_here' \
  -H 'Content-Type: application/json' \
  -d '{
  "controls": ["play-large", "rewind", "play", "fast-forward", "current-time", "volume", "captions", "settings", "pip", "fullscreen", "airplay", "cast"],
  "primaryColor": "#4874F1",
  "controlsColor": "#FFFFFF",
  "captionsColor": "#FFFFFF",
  "captionsBackgroundColor": "#000000",
  "captionsFontSize": 14,
  "saveProgress": false,
  "pandaBranding": true,
  "defaultLanguage": "",
  "timeDisplayType": "CURRENT_TOTAL_TIME",
  "refCode": "",
  "settingsControls": {
    "speed": true,
    "quality": true,
    "dubbing": true,
    "captionsLanguage": true
  },
  "fbPixel": ["124514141"],
  "gtagIds": []
}'

POST /player

Authorization

HTTP Method & Path

Authentication Requirements

Parameters

Request Body

Body Parameters

Example Request Body

Response

Success Response (200)

Response Schema

Error Responses

Example Usage

cURL

200Player configuration updated successfully.

401Unauthorized

403Forbidden

422Unprocessable Entity

500Internal Server Error