playlists

Remove a playlist item

Remove one item from a playlist. The remaining items keep their existing order.

Removes the item and closes the gap in the positions. Returns the whole playlist.

Notes.

  • An unknown itemId is not refused: nothing is removed and the answer is 200 with the playlist.
  • 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.
delete/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.

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.