v1

latestOpenAPI 3.1.02026-07-2416666272.6 KB

Profiles

Update profile

Updates an existing video player profile

put/profile/{profile_id}

Path parameters

profile_idstring uuid required

Unique identifier of the profile

Request body

namestring

Profile name (usually an ID)

exclusiveboolean

Whether this is an exclusive profile

hideControlsOnStartboolean nullable

Whether to hide controls when video starts

generalobject

General configuration settings

controlsstring[]

List of enabled player controls

Example request

{
  "name": "63351f5e-327b-4d9b-8c0c-a3a6ec79d719",
  "colors": {
    "background": "#000000",
    "captionsColor": "#FFFFFF",
    "captionsBackgroundColor": "#000000",
    "controlsColor": "#FFFFFF",
    "primaryColor": "#8000FA"
  },
  "vsl": {
    "alternativeProgress2xLimit": 50,
    "alternativeProgressHeight": 10,
    "alternativeProgressVelocity": 2,
    "autoplay": true,
    "mutedIndicatorIcon": true,
    "mutedIndicatorFontSize": 22,
    "mutedIndicatorTextTop": "Click here",
    "mutedIndicatorTextBottom": "to activate the sound",
    "mutedIndicatorBackgroundColor": "rgba(128, 0, 250, 1.00)",
    "mutedIndicatorTextColor": "rgba(255, 255, 255, 1.00)",
    "gtagIds": [
      null
    ],
    "pandaBranding": true,
    "mutedIndicatorAnimation": "impact",
    "mutedIndicatorLoopDuration": 15,
    "mutedIndicatorSize": "small",
    "mutedIndicatorBorderSize": 2
  },
  "saveProgress": {
    "saveProgress": true,
    "initQuality": 720,
    "saveProgressScreen": true,
    "saveProgressTitle": "Continue learning?",
    "saveProgressBackgroundOpacity": 0.8,
    "saveProgressButton1Title": "Continue",
    "saveProgressButton2Title": "Start over"
  },
  "general": {},
  "controls": [
    "play-large",
    "play",
    "progress",
    "volume",
    "captions",
    "settings",
    "fullscreen"
  ]
}

Response

Profile updated successfully

Example response

{
  "data": {
    "controls": [
      "play-large",
      "play",
      "progress",
      "volume",
      "captions",
      "settings",
      "fullscreen"
    ],
    "colors": {
      "background": "#000000",
      "captionsColor": "#FFFFFF",
      "captionsBackgroundColor": "#000000",
      "controlsColor": "#FFFFFF",
      "primaryColor": "#8000FA"
    },
    "saveProgress": {
      "saveProgress": true,
      "initQuality": 720,
      "saveProgressScreen": true,
      "saveProgressTitle": "Continue learning?",
      "saveProgressBackgroundOpacity": 0.8,
      "saveProgressButton1Title": "Continue",
      "saveProgressButton2Title": "Start over"
    },
    "vsl": {
      "alternativeProgress2xLimit": 50,
      "alternativeProgressHeight": 10,
      "alternativeProgressVelocity": 2,
      "autoplay": true,
      "mutedIndicatorIcon": true,
      "mutedIndicatorFontSize": 22,
      "mutedIndicatorTextTop": "Click here",
      "mutedIndicatorTextBottom": "to activate the sound",
      "mutedIndicatorBackgroundColor": "rgba(128, 0, 250, 1.00)",
      "mutedIndicatorTextColor": "rgba(255, 255, 255, 1.00)",
      "gtagIds": [
        null
      ],
      "pandaBranding": true,
      "mutedIndicatorAnimation": "impact",
      "mutedIndicatorLoopDuration": 15,
      "mutedIndicatorSize": "small",
      "mutedIndicatorBorderSize": 2
    },
    "general": {},
    "updated_at": "2025-08-01T03:31:46.711Z"
  }
}