playlists

Reorder a playlist's items

Replace a playlist's entire item list in one call. Send the full array of items in the order you want; the same reference and loop validation applies as when adding a single item.

Sets the order of the items: itemIds[0] plays first. Unknown ids are skipped. It does not add or remove items. Returns the whole playlist.

Notes.

  • Items left out of itemIds keep their old position number, so two items can share a position. Send every item id.
  • A missing or malformed body is treated as an empty list, not refused.
put/v1/playlists/{id}/items

Request

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

Path parameters

idstring required

Playlist id.

Request body

itemIdsstring[] required

Item ids in the new order.

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.