library

Add Media

Changed on

Add Media to the Library, optionally replacing an existing media item, optionally adding to a playlist.

post/library

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/library
  • Auth
    none declared

Request body multipart/form-data

filesstring binary required

The Uploaded File

namestring

Optional Media Name

oldMediaIdinteger

Id of an existing media file which should be replaced with the new upload

updateInLayoutsinteger

Flag (0, 1), set to 1 to update this media in all layouts (use with oldMediaId)

deleteOldRevisionsinteger

Flag (0 , 1), to either remove or leave the old file revisions (use with oldMediaId)

tagsstring

Comma separated string of Tags that should be assigned to uploaded Media

expiresstring

Date in Y-m-d H:i:s format, will set expiration date on the uploaded Media

playlistIdinteger

A playlistId to add this uploaded media to

widgetFromDtstring

Date in Y-m-d H:i:s format, will set widget start date. Requires a playlistId.

widgetToDtstring

Date in Y-m-d H:i:s format, will set widget end date. Requires a playlistId.

deleteOnExpiryinteger

Flag (0, 1), set to 1 to remove the Widget from the Playlist when the widgetToDt has been reached

applyToMediainteger

Flag (0, 1), set to 1 to apply the widgetFromDt as the expiry date on the Media

folderIdinteger

Folder ID to which this object should be assigned to

Response

successful operation

Changes