Playlist editor API

Update many entries at once

PATCH/editor/api/v1/playlists/{pid}/streams/{kind}/

Called with a playlist editor API token. How

Changes up to 5,000 entries of one kind in one edit you can undo: each item gives an entry id and the fields to change. Answers the changed rows.

Path parameters

  • kindstringrequired

    live (channels), movie (movies) or series (TV shows).

    One of: "live" "movie" "series"

  • pidstring (uuid)required

Headers

  • X-Token-Passwordstring

    The token's own password, when it was made with one.

Body

  • itemsobject[]
    • idintegerrequired
    • namestring
    • urlstring
    • logostring
    • epg_idstring
    • epg_shiftstring (decimal)
    • numberinteger
    • catchup_daysinteger
    • tmdb_idintegercan be null
    • ratingstring (decimal)can be null
    • hiddenboolean
    • sync_nameboolean
    • categoryinteger

Response

200 OK

  • changeobjectrequiredcan be null

    The history record this edit made; null when nothing changed.

    • idintegerrequired
    • seqintegerrequired

      Its place in the playlist's history.

    • labelstringrequired

      What was done, in words.

    • operationstringrequired
    • countintegerrequired

      How many entries it changed.

    • undoablebooleanrequired
    • created_atstring (date-time)required
  • versionintegerrequired

    The playlist's version after the edit.

  • rowsany[][]required

    The changed entries, each a list of values in this order: id, category, name, source_name, url, logo, epg_id, epg_shift, number, catchup_days, tmdb_id, rating, hidden, sync_name, deleted_at, created_at, updated_at, provider, episodes.

Errors

  • 400 Something sent is not valid. Each field that is wrong is named with what is wrong.
  • 401 No credential, or one that is wrong, expired or revoked.
  • 403 The account, or the key's or app's scopes, may not do this.
  • 404 Nothing with this id, or nothing the account can see.
  • 429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means