playlists

Update a playlist item

Edit one playlist item's duration, loop count, fit, full-screen setting, screen tag rules or allocation. refKind and refId cannot be changed on an existing item; delete it and add a new item to point at different content.

Notes.

  • An unknown itemId is not refused: nothing changes and the answer is 200 with the playlist.
  • targetTags and excludeTags are stored but not returned on the items.
  • Fields of the wrong type are ignored rather than refused.
  • The returned playlist row (updatedAt, approvalState) is the one read before this edit; an approved playlist is returned to draft in storage by this call. Re-read with GET to see it.
patch/v1/playlists/{id}/items/{itemId}

Request

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

Path parameters

idstring required

Playlist id.

itemIdstring required

Playlist item id.

Request body

durationMode'fixed' | 'full' | 'live' | 'loop' | 'manual'
durationSecondsnumber

Dwell for fixed, rounded and clamped to 1 second through 24 hours.

loopCountnumber

Plays per turn for loop; rounded.

fit'contain' | 'cover' | 'fill' | 'blur-fill' nullable

The item's own fit; null = follow the file's fit.

fullscreenboolean

Take over the whole screen, over any layout.

playOnlyWhenTappedboolean

Skip it in the rotation; show it only from a show-design tap.

targetTagsstring[] nullable

Play only on screens with one of these tags. null or [] clears the rule.

excludeTagsstring[] nullable

Never play on screens with one of these tags. null or [] clears the rule.

allocationIdstring nullable

Put the item in one of this playlist's allocations; null = the base rotation.

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.