Skip to main content
Glama

Update Appearance Customizations

update_appearance_customizations
Destructive

Apply partial updates to a video's appearance customizations, changing only specified fields; set a field to null to revert to default.

Instructions

Applies a partial update to a video's appearance 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

NameRequiredDescriptionDefault
accountNoNamed private Wistia account; selects credentials, not a remote account ID.
confirmNoSet true only when the user asked for exactly this action.
payloadNoComplete JSON request body instead of body flags. Supports current nested customization, caption and nullable values.
brandingNoIf false, Wistia branding is hidden on the player.
media_idYesThe hashed ID of the video to be customized.
playerColorNoBase color of the player as a hexadecimal RGB string (no leading '#').
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
contrastIconsNoIf true, control icons use a higher-contrast treatment.
roundedPlayerNoCorner radius of the player in pixels. 0 disables rounding.
opaqueControlsNoIf true, player controls render on an opaque background.
showCustomerLogoNoIf true, your customer logo is shown on the player.
playerColorGradientNo
customerLogoImageUrlNoURL of the customer logo image to display on the player.
customerLogoPlacementNoPlacement of the customer logo on the player (e.g. top-right).
customerLogoTargetUrlNoURL the customer logo links to when clicked.
customerLogoSizePercentNoSize of the customer logo as a percentage of the player.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed12 schema fields changedv3.0.0
    • addedInput schema / $defs
      Added value: +{
      +  "playerColorGradient": {
      +    "description": "Optional gradient applied to the player color.",
      +    "properties": {
      +      "colors": {
      +        "description": "Ordered list of [hex color, stop] pairs defining the gradient.",
      +        "items": {
      +          "type": "array"
      +        },
      +        "type": "array"
      +      },
      +      "on": {
      +        "description": "Whether the gradient is enabled.",
      +        "type": "boolean"
      +      }
      +    },
      +    "type": "object",
      +    "unevaluatedProperties": false
      +  }
      +}
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true for the specific user-requested write."New value: +"Set true only when the user asked for exactly this action."
    • addedInput schema / properties / payload / properties / playerColorGradient / $ref
      Added value: +"#/$defs/playerColorGradient"
    • removedInput schema / properties / payload / properties / playerColorGradient / description
      Removed value: -"Optional gradient applied to the player color."
    • removedInput schema / properties / payload / properties / playerColorGradient / properties
      Removed value: -{
      -  "colors": {
      -    "description": "Ordered list of [hex color, stop] pairs defining the gradient.",
      -    "items": {
      -      "type": "array"
      -    },
      -    "type": "array"
      -  },
      -  "on": {
      -    "description": "Whether the gradient is enabled.",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / payload / properties / playerColorGradient / type
      Removed value: -"object"
    • removedInput schema / properties / payload / properties / playerColorGradient / unevaluatedProperties
      Removed value: -false
    • addedInput schema / properties / playerColorGradient / $ref
      Added value: +"#/$defs/playerColorGradient"
    • removedInput schema / properties / playerColorGradient / description
      Removed value: -"Optional gradient applied to the player color."
    • removedInput schema / properties / playerColorGradient / properties
      Removed value: -{
      -  "colors": {
      -    "description": "Ordered list of [hex color, stop] pairs defining the gradient.",
      -    "items": {
      -      "type": "array"
      -    },
      -    "type": "array"
      -  },
      -  "on": {
      -    "description": "Whether the gradient is enabled.",
      -    "type": "boolean"
      -  }
      -}
    • removedInput schema / properties / playerColorGradient / type
      Removed value: -"object"
    • removedInput schema / properties / playerColorGradient / unevaluatedProperties
      Removed value: -false
  2. First observedv2.0.0

TDQS

A4.2/5.0
Behavior5/5

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

Goes well beyond the annotations (destructiveHint=true, idempotentHint=false) by disclosing partial-update semantics ('only the fields supplied are changed') and the non-obvious null-means-delete behavior that reverts to default. It also flags side effects ('may share access, notify people or incur provider charges') and the confirm=true requirement, which are exactly the traits an agent needs before mutating.

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?

Front-loaded with the two most important facts (partial update, null deletes) before the permission boilerplate. The permission section is bulky but placed after the key behavior, and every remaining sentence carries actionable information.

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 destructive, 16-parameter mutation with an implicit (no) output schema, the description covers change semantics, deletion behavior, auth requirements, and the confirm gate. It stops short of describing error conditions or return shape, but the essential calling information is present.

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 94%, so the baseline is 3, but the description adds genuine parameter-level behavior the schema only hints at: null values delete a field and unspecified fields are left untouched. That materially clarifies how to use any of the 16 fields.

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 and resource ('partial update to a video's appearance customizations'), which separates it from sibling customization updaters like update_playback_customizations and update_thumbnail_customizations. It does not name those siblings explicitly, so an agent must infer the distinction, but the scope is unambiguous.

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

Usage Guidelines4/5

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

Gives concrete prerequisites: a token with 'Read, update & delete anything' (or a delegating token) and confirm=true for the mutation. This is clear context for when the call is allowed, though it offers no explicit when-to-use-this-vs-an-alternative guidance.

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