playlists

Create a playlist

Create a playlist with a name and an optional nodeId and other fields. Safe to retry with an idempotency key, to protect against duplicate creation from a double-click.

Creates an empty playlist. Add items with POST /v1/playlists/{id}/items. Send an Idempotency-Key header to make a retry safe.

Notes.

  • The create response is the new row plus empty items and allocations; it omits fit, usedByScreenCount, usedByScreens and the other columns that GET returns.
post/v1/playlists

Request

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

Request body

namestring required
descriptionstring
shuffleboolean
fullscreenboolean
startsAtstring

YYYY-MM-DD or ISO-8601.

expiresAtstring

YYYY-MM-DD or ISO-8601.

nodeIdstring

Home location; defaults to your own.

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.