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

# Update Engagement Customizations

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

## Request

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

Applies a partial update to a video's engagement 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: On-video engagement settings for a video: the end/pause Call To Action (postRoll-v1) and timed annotation links (midrollLink-v1). 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: Container for engagement plugin configurations.
    - `postRoll-v1` object: Adds a Call To Action to your Video.
      - `rewatch` boolean: If set to true, allows the video to be rewatched.
      - `text` string: The text to be displayed.
      - `link` string: The URL of the link to be displayed.
      - `time` union: The time when the post-roll should be displayed. Can be a string like "end" or a number representing seconds.
        - string
        - number
      - `autoSize` boolean: If set to true, the post-roll will automatically adjust its size.
      - `style` object
        - `backgroundColor` string: The background color of the post-roll.
      - `ctaType` string: The type of call-to-action to be displayed. Typically set to "text". Other options are "image" which allows for "altText", and "html".
      - `on` boolean: If set to true, the post-roll is enabled.
      - `conversionOpportunityKey` string: The key used for tracking conversion opportunities.
    - `midrollLink-v1` object: Timed annotation links that appear over the video at specific times.
      - `on` boolean: If set to true, the timed annotation links are enabled.
      - `links` object[]: The set of annotation links.
        - `text` string: The text of the annotation link.
        - `url` string: The URL the annotation link points to.
        - `time` string: The time (in seconds) at which the link appears.
        - `duration` string: How long (in seconds) the link remains visible.

## Response `200`

Engagement customization update successful

- object: Explicitly-set engagement customizations for the video. Values are returned as strings (e.g. "true"); fields that have never been set are omitted.
  - `plugin` object
    - `postRoll-v1` object
      - `rewatch` string
      - `text` string
      - `link` string
      - `time` string
      - `autoSize` string
      - `style` object
        - `backgroundColor` string
      - `ctaType` string
      - `on` string
      - `conversionOpportunityKey` string
    - `midrollLink-v1` object
      - `on` string
      - `links` object[]
        - `text` string
        - `url` string
        - `time` string
        - `duration` string
        - `conversionOpportunityKey` 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/engagement/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)