Update share link
update_share_linkSet the share link for a single media to control viewer access; if missing, create one with the chosen visibility.
Instructions
Updates the share link for a single media. If the media does not have a share link yet, one is created with the supplied visibility.
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.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| account | No | Named private Wistia account; selects credentials, not a remote account ID. | |
| confirm | No | Must be true for the specific user-requested write. | |
| payload | No | Complete JSON request body instead of body flags. Supports current nested customization, caption and nullable values. | |
| media_id | Yes | The hashed ID of the media. | |
| visibility | No | Controls who can view the media via this share link. - `unlocked`: anyone with the link can view the media. - `account`: only signed-in members of the media's account can view. - `locked`: only contacts with access to the media's folder can view. - `domain_verified`: only viewers signed in with an email address at a domain verified on the media's account can view. Requires the account to be enrolled in the domain validation gate; otherwise setting this value returns 400. | |
| payload_file | No | Regular local JSON body file, at most 5 MB. Cannot be mixed with body flags or payload. |