Skip to main content
Glama

Update Playback Customizations

update_playback_customizations
Destructive

Update a Wistia video's playback customizations by changing only specified fields; set a field to null to delete it and restore its default.

Instructions

Applies a partial update to a video's playback customizations. Only the fields supplied are changed; sending a field as null deletes it (reverting to the default).

Requires api token with one of the following permissions

Read, update & delete anything

Tokens with the "Act with a team member's permissions" permission (all:delegate_to_contact_permissions scope) can also be used. Requests made with such a token are authorized using the permissions of the contact assigned to the token. Requires confirm=true for the requested mutation. May share access, notify people or incur provider charges.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
hlsNoIf set to true, HLS adaptive bitrate streaming is enabled.
seoNoIf set to true, the video’s metadata will be injected into the page’s markup for SEO.
timeNoSets the starting time of the video.
emailNoAssociate a specific email address with this video’s viewing sessions.
mutedNoIf set to true, the video will start in a muted state.
wmodeNoIf set to transparent, the background behind the player will be transparent instead of black.
volumeNoSets the volume of the video.
accountNoNamed private Wistia account; selects credentials, not a remote account ID.
bpbTimeNoControls when the big play button appears, expressed as a string.
confirmNoMust be true for the specific user-requested write.
payloadNoComplete JSON request body instead of body flags. Supports current nested customization, caption and nullable values.
playbarNoIf set to true, the playbar will be available. If set to false, it will be hidden.
preloadNoSets the video’s preload property. Possible values are metadata, auto, none, true, and false.
autoPlayNoIf set to true, the video will play as soon as it’s ready. Note that autoplay might not work on some devices and browsers.
media_idYesThe hashed ID of the video to be customized.
resumableNoDetermines if the video should resume from where the viewer left off. Options are "true", "false", and "auto".
sphericalNoIf set to true, the video is rendered as a spherical (360-degree) video.
videoFoamNoWhen set to true, the video will adjust its size according to its parent element. It can also be an object specifying min/max width or height.
doNotTrackNoIf set to true, data for each viewing session will not be tracked.
keyMomentsNoIf set to false, the key moments feature will be disabled.
playButtonNoIndicates if the play button is visible.
qualityMaxNoSpecifies the maximum quality the video will play at.
qualityMinNoSpecifies the minimum quality the video will play at.
playsinlineNoIf set to false, videos will play within the native mobile player.
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
playlistLoopNoIf set to true and this video has a playlist, it will loop back to the first video after the last one has finished.
videoQualityNoSets the default video quality the video will play at.
clickForSoundNoIf set to true, viewers can click to enable sound on a muted video.
playlistLinksNoEnables the use of specially crafted links on the page to associate with a video, turning them into a playlist.
volumeControlNoWhen set to true, a volume control is available over the video.
fakeFullScreenNoIf set to true, the video will try to play in a pseudo-fullscreen mode on certain mobile devices.
qualityControlNoIf set to false, the video quality selector in the settings menu will be hidden.
silentAutoPlayNoDetermines how videos handle autoplay in contexts where normal autoplay might be blocked. Options are "true", "allow", and "false".
googleAnalyticsNoGoogle Analytics tracking configuration to associate with this video’s viewing sessions.
settingsControlNoIf set to true, the settings control will be available.
smallPlayButtonNoIf set to true, the small play button control is shown.
endVideoBehaviorNoDetermines what happens when the video ends. Options are "default" (stays on the last frame), "reset" (shows thumbnail and controls), and "loop" (plays again from the start).
fullscreenButtonNoIf set to true, the fullscreen button will be available as a video control.
playPauseNotifierNoIf set to false, animations for the Pause and Play symbols will be removed.
playbackRateControlNoIf set to false, the playback speed controls in the settings menu will be hidden.
controlsVisibleOnLoadNoIf set to true, controls like the big play button, playbar, volume, etc. will be visible as soon as the video is embedded.
playSuspendedOffScreenNoIf set to false for a muted autoplay video, the video won’t pause when out of view.
copyLinkAndThumbnailEnabledNoIf set to false, the option to “Copy Link and Thumbnail” will be removed when right-clicking on the video.
fullscreenOnRotateToLandscapeNoIf set to false, the video will not automatically go to fullscreen mode on mobile when rotated to landscape.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv2.0.0

TDQS

A4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Beyond the annotations, the description discloses several high-value behavioral traits: partial-update semantics, that sending a field as null deletes it and reverts to default, the exact permission scopes needed, the confirm=true requirement, and the side effects ('May share access, notify people or incur provider charges'). This substantially exceeds what destructiveHint/idempotentHint already convey.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The core purpose and null-deletion behavior are front-loaded in the first sentence, with the permission/auth details kept in a separate structured block. It is appropriately sized for a 44-parameter tool, though the permissions section is somewhat bulky.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex mutation tool with 44 parameters, nested objects, and no output schema, the description covers purpose, mutation semantics, auth, confirmation, and side effects well. Return-value/response behavior is not addressed, but with no output schema this is a minor gap.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100%, so the baseline is 3, but the description adds meaning the schema does not: null values delete a field and revert to default, which is critical semantics for any of the 44 parameters. This is meaningful added value beyond the per-field schema text.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb ('Applies a partial update') and resource ('a video's playback customizations'), and the 'playback' qualifier clearly separates it from the many sibling customization tools (update_customizations, update_thumbnail_customizations, etc.). It is clear but does not explicitly name or contrast with those siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the tool's context through its mutation semantics and permission requirements, and requires confirm=true, but it never states when to prefer this over update_customizations or the other customization updaters, nor when not to use it. Usage is implied rather than prescribed.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools