minimusdocs
Help center

Playlist editor

Update a playlist

PATCH/editor/playlists/{pid}/

write Change: creates or edits. Scopes

Changes its name, the expiry date and message players are told, or any of its settings: only the fields sent change. Answers the playlist as GET does.

Path parameters

  • pidstring (uuid)required

    The playlist's id.

Body

  • namestring
  • expirystring (date-time)can be null
  • messagestring
  • max_connectionsinteger
  • track_connectionsboolean
  • limit_connectionsboolean
  • time_shiftstring (decimal)
  • languagestring
  • provider_vod_infoboolean
  • auto_vod_infoboolean
  • vod_info_optionsany
  • epg_gzipboolean
  • use_tvg_idboolean
  • epg_dummy_textstring
  • epg_daysinteger
  • epg_fieldsany
  • epg_precisioninteger
  • epg_overrideboolean
  • epg_hide_shortboolean
  • epg_show_idsboolean
  • logo_precisioninteger
  • logo_overrideboolean
  • hidden_providerboolean
  • custom_domainstring
  • welcomeany
  • app_colorstring
  • app_logostring (uri)
  • stream_formatstring
    • ts - MPEG-TS (no /live/)
    • live_ts - MPEG-TS with /live/
    • live_hls - HLS with /live/

    One of: "ts" "live_ts" "live_hls"

Response

200 OK

  • idstring (uuid)required
  • namestringrequired
  • positionintegerrequired

    Playlists are listed by position.

  • ownerstringrequired

    The username of the account that owns it.

  • usernamestringrequired

    The login players sign in with to this playlist.

  • passwordstringrequired
  • expirystring (date-time)requiredcan be null

    The expiry date players are told; null: none.

  • messagestringrequired

    The message players are told.

  • countsobjectrequired
    • liveintegerrequired

      Channels.

    • movieintegerrequired

      Movies.

    • seriesintegerrequired

      TV shows.

    • episodesintegerrequired
    • usersintegerrequired

      Customers it is handed to.

  • providersobject[]required
    • idintegerrequired
    • typestringrequired

      How its content is read, e.g. xtream (a provider login: server, username and password) or m3u (a playlist link).

    • urlstringrequired

      The address its streams start with.

    • labelstringrequired
    • sourcestringrequired

      An m3u provider's playlist link, its password hidden; '' for other types.

  • last_synced_atstring (date-time)requiredcan be null
  • updated_atstring (date-time)required
  • versionintegerrequired

    Moves with every change to what its links serve.

  • custom_domainstringrequired

    The domain its links use; '' for the panel's.

  • settingsobjectrequired

    Every setting of a playlist.

    • max_connectionsinteger
    • track_connectionsboolean
    • limit_connectionsboolean
    • time_shiftnumberrequired

      Hours added to the server time players are told.

    • languagestring
    • provider_vod_infoboolean
    • auto_vod_infoboolean
    • vod_info_optionsany
    • epg_gzipboolean
    • use_tvg_idboolean
    • epg_dummy_textstring
    • epg_daysinteger
    • epg_fieldsany
    • epg_precisioninteger
    • epg_overrideboolean
    • epg_hide_shortboolean
    • epg_show_idsboolean
    • logo_precisioninteger
    • logo_overrideboolean
    • hidden_providerboolean
    • custom_domainstring
    • welcomeany
    • app_colorstring
    • app_logostring (uri)
    • stream_formatstring
      • ts - MPEG-TS (no /live/)
      • live_ts - MPEG-TS with /live/
      • live_hls - HLS with /live/

      One of: "ts" "live_ts" "live_hls"

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