minimusdocs
Help center

Playlist editor

Remove episodes for good

POST/editor/playlists/{pid}/series/{series_id}/episodes/purge/

manage Delete and money: deletes, credits, servers or panel settings. Scopes

Removes episodes that are in the recycle bin for good (any other episode refuses the request). This cannot be undone.

Path parameters

  • pidstring (uuid)required

    The playlist's id.

  • series_idintegerrequired

    The TV show's id (a row of the series list).

Body

  • idsinteger[]required

Response

200 OK

  • changeobjectrequiredcan be null

    The change it made in the history; null when nothing changed.

    • idintegerrequired
    • seqintegerrequired

      Its place in the playlist's history.

    • labelstringrequired

      What it did, in words, e.g. "Renamed 12 channels".

    • operationstringrequired

      The kind of edit, e.g. save, rename, move, delete, purge, sort, tool:replace, undo.

    • kindstringrequired

      The list it changed: live, movie or series; empty when it was not one list.

    • countintegerrequired

      How many rows it changed.

    • undoablebooleanrequired

      Whether it can still be undone or reverted.

    • undonebooleanrequired

      Whether it is undone (redo brings it back).

    • created_atstring (date-time)required
  • versionintegerrequired

    The playlist's version after the edit.

  • rowsany[][]required

    The TV shows' rows (their episode counts change). Each row is an array 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.

  • categoriesobject[]required

    The categories it changed.

    • idintegerrequired
    • namestringrequired
    • source_namestringrequired

      Its name at the provider ('' for one made in the editor).

    • positionintegerrequired

      Categories are listed by position.

    • hiddenbooleanrequired

      Hidden from the playlist players get.

    • sync_namebooleanrequired

      Takes the provider's name again at each sync.

    • deleted_atstring (date-time)requiredcan be null

      When it went to the recycle bin; null when it is not there.

    • countintegerrequired

      How many rows it shows.

  • removedinteger[]required

    Ids of rows removed for good.

  • episodesobject[]requiredcan be null

    The episodes it changed; null when there are too many to send: load them again.

    • idintegerrequired
    • seasonintegerrequired

      -1: none.

    • numberintegerrequired

      -1: none.

    • namestringrequired
    • urlstringrequired

      The stream address players open.

    • infoobjectrequired
    • deleted_atstring (date-time)requiredcan be null

      When it went to the recycle bin; null when it is not there.

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