API Reference

Update profile

Updates an existing video player profile

Update Profile

The Update Profile endpoint enables comprehensive modification of existing video player configurations. This powerful endpoint allows you to customize every aspect of your player's appearance, behavior, and functionality, making it the primary tool for maintaining and evolving your video player experiences.

Overview

This endpoint provides complete control over profile configurations, supporting partial updates to any combination of settings. Whether you need to adjust simple visual elements like colors or implement complex Video Sales Letter features, this endpoint handles all configuration changes while maintaining data integrity and system compatibility.

What You Need to Provide

To update a profile, specify:

  • Profile ID: The unique UUID identifier in the URL path
  • Complete Configuration: JSON object containing full configuration objects for any section you want to modify

Critical Update Behavior

Full Object Replacement: When updating complex configuration objects (colors, vsl, saveProgress, general), the entire object is replaced. This means:

  1. Always retrieve current settings first using the Get Profile Details endpoint
  2. Modify the retrieved configuration with your desired changes
  3. Send the complete modified configuration in your update request

Available Configuration Options

Basic Settings

  • Name: Profile identifier (typically 3-100 characters)
  • Exclusive: Boolean flag for access restrictions
  • Hide Controls on Start: Initial player control visibility

Player Controls

Configure which interactive elements appear in the player:

  • Available Controls: play-large, play, progress, volume, captions, settings, fullscreen, pause, quality
  • Custom Combinations: Enable only the controls needed for your specific use case

Visual Customization

Comprehensive color configuration for complete visual control:

  • Caption Colors: Text and background colors for subtitle display
  • Control Colors: Player button and interface element colors
  • Primary Color: Main theme color for branding consistency
  • Background Color: Player background customization

Video Sales Letter (VSL) Features

Advanced engagement and conversion optimization tools:

  • Autoplay Configuration: Smart autoplay with behavior controls
  • Muted Indicator: Customizable unmute prompts with animations and styling
  • Progress Bar: Alternative progress displays with velocity controls
  • Interaction Controls: Disable pause, forward seeking, or restart behaviors
  • Tracking Integration: Facebook Pixel and Google Analytics support
  • Branding Options: Panda branding visibility controls

Save Progress Functionality

User experience enhancements for content consumption:

  • Resume Capability: Enable viewer position saving
  • Quality Settings: Default and initial quality configurations
  • UI Customization: Progress dialog titles, buttons, and opacity settings
  • Screen Behavior: Control when and how resume prompts appear

General Configuration

Flexible settings container for specialized requirements and future feature additions.

Authentication Requirements

This endpoint requires valid authentication credentials with appropriate permissions to modify profiles within your account. The system enforces strict ownership validation to ensure profile security.

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!