Customizations

Update Accessibility Customizations

Changed on

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 created with the all:delegate_to_contact_permissions scope and an authorization granting the edit permission on this media can also be used.

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

Path parameters

mediaIdstring required

The hashed ID of the video to be customized.

Headers

X-Wistia-API-Versionstring required

Request body

captionsBackgroundColorstring

Background color of the captions as a hexadecimal RGB string (no leading '#').

captionsBorderRadiusinteger

Corner radius of the captions background in pixels.

captionsTextColorstring

Color of the captions text as a hexadecimal RGB string (no leading '#').

captionsTextSizeinteger

Size of the captions text in pixels.

captionsFontFamilystring

Font family used for the captions text.

transcriptEnabledboolean

If true, the interactive transcript is shown alongside the video.

showTranscriptSpeakersboolean

If true, speaker labels are displayed in the transcript.

audioDescriptionControlboolean

If true, the audio description control is available to viewers.

Example request

{
  "captionsBackgroundColor": "000000",
  "captionsTextColor": "ffffff"
}

Response

Accessibility customization update successful

captionsBackgroundColorstring
captionsBorderRadiusstring
captionsTextColorstring
captionsTextSizestring
captionsFontFamilystring
transcriptEnabledstring
showTranscriptSpeakersstring
audioDescriptionControlstring

Changes