---
title: "Update Related Media Customizations"
method: PUT
path: "/medias/{mediaId}/customizations/related_media"
tags: ["Customizations"]
---

# Update Related Media Customizations

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

## Request

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

Applies a partial update to a video's related-media 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: Related-media ("discover more") recommendations shown on the video. Every field is optional; only the fields you send are changed (partial update). Send a field as null to reset it to its default.
  - `plugin` object
    - `relatedMedia` object: Configuration for the related-media recommendations plugin.
      - `on` boolean: Whether related-media recommendations are enabled.
      - `hashedIdList` string[]: Ordered list of media hashed IDs to recommend.
      - `shouldShowOnPause` boolean: If true, recommendations are shown when the video is paused.
      - `shouldShowOnEnd` boolean: If true, recommendations are shown when the video ends.
      - `mediaLabelText` string: Label text displayed above the recommended media.
      - `watchButtonText` string: Text shown on the watch button for a recommended media.

## Response `200`

Related media customization update successful

- object: Explicitly-set related-media customizations for the video. Values are returned as strings (e.g. "true"); fields that have never been set are omitted.
  - `plugin` object
    - `relatedMedia` object
      - `on` string
      - `hashedIdList` string[]
      - `shouldShowOnPause` string
      - `shouldShowOnEnd` string
      - `mediaLabelText` string
      - `watchButtonText` 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/related_media/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)