WIwistia
Media

Update Media

Changed on

Updates the attributes on a media.

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/{mediaHashedId}

Request

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

Path parameters

mediaHashedIdstring required

Hashed ID of the media (e.g., "4d23503f70")

The hashed ID of the media.

Headers

X-Wistia-API-Versionstring required

Request body

namestring

The media’s new name.

new_still_media_idstring

The Wistia hashed ID of an image that will replace the still that’s displayed before the player starts playing.

descriptionstring

A new description for this media. Accepts plain text or markdown.

tagsstring[]

An array of tag names to apply to the media. This replaces any existing tags. To add tags without replacing existing tags, use bulk-tag-media.

custom_metadataobject

Custom metadata field values to set, keyed by field key. Values take the same shapes as the Set Custom Metadata Field Value endpoint; a null value clears that field and omitted fields are untouched. Requires the custom metadata feature on the account.

Response

Successful response

idinteger

A unique numeric identifier for the media within the system.

namestring

The display name of the media.

type'Video' | 'Audio' | 'Image' | 'PdfDocument' | 'MicrosoftOfficeDocument' | 'Swf' | 'UnknownType'

A string representing what type of media this is.

archivedboolean

Whether or not the media is archived, either true or false.

createdstring date-time

The date when the media was originally uploaded.

updatedstring date-time

The date when the media was last changed.

durationnumber nullable

Specifies the length (in seconds) for audio and video files. Specifies number of pages in the document. Omitted for other types of media.

embedCodestring

DEPRECATED: If you want to programmatically embed videos, follow the construct an embed code guide.

hashed_idstring

A unique alphanumeric identifier for this media.

descriptionstring

A description for the media which usually appears near the top of the sidebar on the media's page.

progressnumber

A floating point value between 0 and 1 that indicates the progress of the processing for this file.

status'queued' | 'processing' | 'ready' | 'failed'

Post upload processing status. - queued: the file is waiting in the queue to be processed. - processing: the file is actively being processed. - ready: the file has been fully processed and is ready for embedding and viewing. - failed: the file was unable to be processed (usually a format or size error).

sectionstring nullable

The title of the section in which the media appears. This attribute is omitted if the media is not in a section (default).

protectedboolean nullable

Whether the media is protected (e.g. requires a password or other authentication to view). Null if the media is not protected.

Changes