media

Update a media asset

Edit a media asset. Accepts name, altText, tags, folderId, node, play-window fields (startsAt, expiresAt, autoArchiveOnExpiry), audioEnabled, a QR code overlay, and web configuration. Changing the URL of a web-kind asset re-checks it to make sure it is safe to fetch.

Send only the fields to change. state and bytes are set by processing and ignored here.

Notes.

  • The response is the stored row, not the GET shape: it has no usageCount, uploadedByName or uploadSource.
  • An invalid fit answers 400 with only error (no message); every other validation failure is 422 validation_error.
patch/v1/media/{id}

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/media/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Media asset id.

Request body

namestring
kind'image' | 'video' | 'audio' | 'pdf' | 'powerpoint' | 'web' | 'dashboard' | 'weather' | 'rss' | 'clock' | 'qr' | 'menu' | 'directory' | 'donor-wall' | 'hall-of-fame' | 'birthday-board' | 'recognition' | 'wayfinding' | 'check-in' | 'emergency' | 'touch-kiosk' | 'package' | 'font'
urlstring

An https URL, a /v1/ path or a data:image URI; for a web link, the page address (private and internal network addresses are refused).

activeboolean

False archives the asset.

folderIdstring nullable
tagsstring[]
altTextstring nullable
thumbnailUrlstring nullable
widthinteger nullable
heightinteger nullable
durationSecnumber nullable
startsAtstring nullable
expiresAtstring nullable
autoArchiveOnExpiryboolean
qrobject nullable
webConfigobject nullable
nodeIdstring nullable

Move to another location (needs media.edit there).

audioEnabledboolean
fit'contain' | 'cover' | 'fill' | 'blur-fill'
baseUpdatedAtstring

The updatedAt your edit is based on. When set and the row has moved since, the write is refused with 409 and the current row.

Response

Success.

Example response

{
  "data": {
    "id": "med_0c1d2e3f4a5b6c7d"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.