playlists

Update a playlist

Edit a playlist's own fields, such as name, node, shuffle, and transition settings. Items are managed through the separate /items routes.

Send only the fields to change. A playback change to an approved playlist returns it to draft where approval is required.

Notes.

  • Fields of the wrong type are ignored rather than refused (for example name: 5).
patch/v1/playlists/{id}

Request

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

Path parameters

idstring required

Playlist id.

Request body

namestring
descriptionstring
shuffleboolean
fullscreenboolean
fit'contain' | 'cover' | 'fill' | 'blur-fill' nullable
startsAtstring nullable
expiresAtstring nullable
nodeIdstring nullable

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

baseUpdatedAtstring

The updatedAt your edit is based on; a stale value answers 409 with current.

Response

Success.

Example response

{
  "data": {
    "id": "pl_4d5e6f7a8b9c0d1e",
    "items": [
      {
        "id": "pli_7a8b9c0d1e2f3a4b"
      }
    ]
  }
}

Changes

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