---
title: "Update Lead Capture Customizations"
method: PUT
path: "/medias/{mediaId}/customizations/lead_capture"
tags: ["Customizations"]
---

# Update Lead Capture Customizations

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

## Request

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

Configures a single lead-capture provider for the video, mapping it to the
appropriate underlying plugin. Only the selected provider is changed.

## 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: Configure viewer email collection for a video using a single provider discriminator. Choose a provider, whether it is enabled, and provider-specific settings. Which settings apply depends on the provider (e.g. a Wistia Form uses hashedId; CRM providers reference an external form).
  - `provider` 'wistia_form' | 'hubspot' | 'marketo' | 'pardot', required: Which lead-capture mechanism to configure.
  - `enabled` boolean: Whether the selected provider is turned on. Defaults to true.
  - `settings` object: Provider-specific settings. Only the fields relevant to the chosen provider are used.
    - `time` string: When the form appears: "start"/"before", a number of seconds, or "end".
    - `allowSkip` boolean: Whether the viewer may skip the form.
    - `hashedId` string: (Wistia Form) The hashed ID of the Wistia form to embed.
    - `displayMode` string: (Wistia Form) How the form is displayed.
    - `showLogo` boolean: (Wistia Form) Whether to show the Wistia logo on the form.
    - `backgroundColor` string: Background color of the form as a hex string.
    - `formId` string: (HubSpot/Marketo/Pardot) The external form identifier.
    - `portalId` string: (HubSpot) The HubSpot portal/account identifier.

## Response `200`

Lead capture customization update successful

- object: Explicitly-set lead-capture plugins for the video. Values are returned as strings. Plugin contents are extensible, so additional keys may be present.
  - `plugin` object
    - `requireEmail-v1` object
      - `on` string
    - `form` object
      - `on` string
    - `hubspotForm` object
      - `on` string
    - `marketoForm` object
      - `on` string
    - `pardotForm` 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/lead_capture/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)