WIwistia
Share Links

Update share link

Changed on

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 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 created with the all:delegate_to_contact_permissions scope and an authorization granting the update permission on this media can also be used.

put/medias/{mediaId}/share_link

Request

  • Base URL
    https://api.wistia.com/modern
  • URL
    https://api.wistia.com/modern/medias/{mediaId}/share_link
  • Auth
    HTTP bearer

Path parameters

mediaIdstring required

The hashed ID of the media.

Headers

X-Wistia-API-Versionstring required

Request body

visibility'unlocked' | 'account' | 'locked' | 'domain_verified' required

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.

Response

Share link update successful

idstring required

The hashed ID of the share link. This appears in the link's URL.

media_idstring required

The hashed ID of the media this share link points to.

urlstring uri required

The full URL viewers can use to view the media via this share link.

slugstring nullable required

The share link's custom slug, if one is set. When present, the slug replaces the hashed ID in the link's URL.

visibility'unlocked' | 'account' | 'locked' | 'domain_verified' required

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.
created_atstring date-time required

When the share link was created.

updated_atstring date-time required

When the share link was last updated.

Changes