Purchase Captions
purchase_captionsBuy English captions for a Wistia media item using the account's saved credit card; confirm to place the order.
Instructions
This method is for purchasing English captions for a media. The request will charge the credit card on the account if successful. A saved credit card is required to use this endpoint.
Requires api token with one of the following permissions
Read, update & delete anythingTokens 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.
Requires confirm=true for the requested mutation. May share access, notify people or incur provider charges.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"media_hashed_id": "<media_hashed_id>"
},
"name": "purchase_captions"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| rush | No | ||
| account | No | Named private Wistia account; selects credentials, not a remote account ID. | |
| confirm | No | Set true only when the user asked for exactly this action. | |
| payload | No | Complete JSON request body instead of body flags. Supports current nested customization, caption and nullable values. | |
| automated | No | ||
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. | |
| media_hashed_id | Yes | Unique identifier for the media. | |
| automatically_enable | No | Automatically enable captions for the media once the order is ready or hold the captions for review before manually enabling. |