Skip to main content
Glama

Apply Brand

apply_brand
Destructive

Apply a brand to Wistia media, folders, or channels to style them with its colors, fonts, logos, and layout; applying the default brand detaches a resource so it inherits again.

Instructions

Applies a brand to a media, folder, or channel, so that resource is styled by the brand's colors, fonts, logos, and layout.

A brand has no effect until it is applied to something. Media inherit from their folder, and folders from the account's default brand, so applying a brand to a folder styles everything inside it that has no brand of its own.

Applying the account-level default brand (is_default: true) is how a resource is un-branded: it detaches the resource so it inherits again.

By default this also clears any brand-mapped appearance settings the resource had set directly, so the brand is what shows. Pass clear_overrides: false to leave those in place.

Responds with the brand now in effect on the resource, which is not always the one you applied : detaching a media returns the brand it falls back to.

Webinars can't be branded through this endpoint yet.

Requires api token with one of the following permissions

All data

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.
brand_idYesThe id of the brand to apply
resource_idNoThe id of the resource being branded.
payload_fileNoRegular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload.
resource_typeNoThe kind of resource being branded. Webinars can't be branded through this endpoint yet.
clear_overridesNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changedv3.0.0
    • addedInput schema / $defs
      Added value: +{
      +  "clear_overrides": {
      +    "default": true,
      +    "description": "When true (the default), appearance settings the resource had set directly are cleared for the fields the brand controls, so the brand is what shows. Set to false to leave them in place, in which case they continue to win over the brand.",
      +    "type": "boolean"
      +  }
      +}
    • addedInput schema / properties / clear_overrides / $ref
      Added value: +"#/$defs/clear_overrides"
    • removedInput schema / properties / clear_overrides / default
      Removed value: -true
    • removedInput schema / properties / clear_overrides / description
      Removed value: -"When true (the default), appearance settings the resource had set directly are cleared for the fields the brand controls, so the brand is what shows. Set to false to leave them in place, in which case they continue to win over the brand."
    • removedInput schema / properties / clear_overrides / type
      Removed value: -"boolean"
    • 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 / clear_overrides / $ref
      Added value: +"#/$defs/clear_overrides"
    • removedInput schema / properties / payload / properties / clear_overrides / default
      Removed value: -true
    • removedInput schema / properties / payload / properties / clear_overrides / description
      Removed value: -"When true (the default), appearance settings the resource had set directly are cleared for the fields the brand controls, so the brand is what shows. Set to false to leave them in place, in which case they continue to win over the brand."
    • removedInput schema / properties / payload / properties / clear_overrides / type
      Removed value: -"boolean"
  2. First observedv2.0.0

TDQS

A4.6/5.0
Behavior5/5

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

Adds substantial context beyond the annotations: the default clear_overrides=true wipes directly-set appearance fields (consistent with destructiveHint=true), the confirm=true requirement is restated in prose, the token/permission scoping is spelled out, and the surprising return semantics (result may be the fallback brand, not the applied one) are disclosed. Annotations cover the safety profile; the description enriches it.

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?

Multi-paragraph but well-front-loaded – the core action and inheritance rule come first, then the override behavior, then the return caveat and limitations. Every section carries non-obvious information, though the auth block could be trimmed since permission scopes are partly structured elsewhere.

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

Completeness5/5

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

For a mutation tool with no output schema, the description covers the operation, inheritance semantics, the destructive default, the authorization requirements, and even the return-value nuance (fallback brand) plus the webinar limitation. Nothing an agent needs to invoke it correctly is missing.

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 88% so the structured layer already documents most parameters, establishing a baseline of 3. The description adds real meaning on top: it explains what clear_overrides=false does behaviorally, that brand_id with the default brand means detach, and that resource_type is constrained (webinars excluded).

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

Purpose5/5

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

States a specific verb (applies) and resource (brand) plus the three target resource types (media, folder, channel), and contrasts with the sibling brand-management tools (create/update/delete_brand) by describing the apply/attach operation. An agent can immediately tell this is the wiring action, not the brand CRUD action.

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?

Explains the inheritance model (media inherit from folder, folders from default brand) and explicitly frames applying the default brand as the un-branding path, which tells the agent when to reach for this tool. It does not name a sibling alternative for un-branding or for styling without a brand, but the when-to-use context is clear.

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