playlists

Set playlist allocations

Set a playlist's allocations: shares of its airtime given to a person, a group or a location (a percent, every nth play, or a time of day). This replaces the whole set; allocations you leave out are removed.

Notes.

  • An out-of-range value is 400 validation_error; every other validation failure is 422.
  • Rows with an unknown ownerKind or kind are dropped without an error.
  • A missing or malformed body is treated as an empty list, which removes every allocation.
  • 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.
put/v1/playlists/{id}/allocations

Request

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

Path parameters

idstring required

Playlist id.

Request body

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.