---
title: "Update Accessibility Customizations"
method: PUT
path: "/medias/{mediaId}/customizations/accessibility"
tags: ["Customizations"]
---

# Update Accessibility Customizations

`PUT /medias/{mediaId}/customizations/accessibility`

## Request

- Base URL: `https://api.wistia.com/modern`
- URL: `https://api.wistia.com/modern/medias/{mediaId}/customizations/accessibility`
- Auth: HTTP bearer

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

An [expiring access token](https://docs.wistia.com/reference/post_expiring-token)
created with the `all:delegate_to_contact_permissions` scope and an
authorization granting the `edit` permission on this media can also be used.

## Path parameters

- `mediaId` string, required

## Headers

- `X-Wistia-API-Version` string, required

## Request body

- object: Accessibility customizations for a video: caption display & styling, transcript display, and audio description. Every field is optional; only the fields you send are changed (partial update). Send a field as null to reset it to its default.
  - `captionsBackgroundColor` string: Background color of the captions as a hexadecimal RGB string (no leading '#').
  - `captionsBorderRadius` integer: Corner radius of the captions background in pixels.
  - `captionsTextColor` string: Color of the captions text as a hexadecimal RGB string (no leading '#').
  - `captionsTextSize` integer: Size of the captions text in pixels.
  - `captionsFontFamily` string: Font family used for the captions text.
  - `transcriptEnabled` boolean: If true, the interactive transcript is shown alongside the video.
  - `showTranscriptSpeakers` boolean: If true, speaker labels are displayed in the transcript.
  - `audioDescriptionControl` boolean: If true, the audio description control is available to viewers.
  - `plugin` object
    - `captions` object: Modern captions plugin configuration.
      - `on` boolean: If set to true, the captions plugin is enabled and captions controls will be available to viewers.
      - `onByDefault` boolean: If set to true, captions will be turned on automatically when the video loads. Only takes effect when the captions plugin is enabled.
    - `captions-v1` object: Enables closed captions for the video.
      - `on` boolean: If set to true, the captions plugin is enabled and captions controls will be available to viewers.
      - `onByDefault` boolean: If set to true, captions will be turned on automatically when the video loads. Only takes effect when the captions plugin is enabled.
    - `extendedAudioDescription` object: Enables an extended audio description track for the video.
      - `on` boolean: If set to true, the extended audio description plugin is enabled.

## Response `200`

Accessibility customization update successful

- object: Explicitly-set accessibility customizations for the video. Values are returned as strings (e.g. "true", "12"); fields that have never been set are omitted.
  - `captionsBackgroundColor` string
  - `captionsBorderRadius` string
  - `captionsTextColor` string
  - `captionsTextSize` string
  - `captionsFontFamily` string
  - `transcriptEnabled` string
  - `showTranscriptSpeakers` string
  - `audioDescriptionControl` string
  - `plugin` object
    - `captions` object
      - `on` string
      - `onByDefault` string
    - `captions-v1` object
      - `on` string
      - `onByDefault` string
    - `extendedAudioDescription` object
      - `on` string

## Other responses

- `400`: Bad request
- `401`: Unauthorized, invalid or missing token
- `403`: Forbidden, token is valid but account does not have access to feature
- `404`: Resource not found
- `500`: Internal server error

## Changes

- **2026-11-03** `b86cb2a7b420`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/wistia/apis/data-api/changes/medias/:mediaId/customizations/accessibility/put.md)

---

[API](https://skmtc.dev/wistia/apis/data-api.md) - [All operations](https://skmtc.dev/wistia/apis/data-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wistia/apis/data-api/revisions/b86cb2a7b420?raw)