minimusdocs
Help center

Playlist editor

Match channels to the guide

POST/editor/playlists/{pid}/epg/match/

write Change: creates or edits. Scopes

Gives the channels scope picks ({"ids": [...]}, {"categories": [...]} (category ids) or {"all": true}) a guide id found by their name. source limits it to one guide source, precision (40 to 100) is how close a name must be, and override also replaces the ids channels have. Up to 2,000 channels are matched at once (200); more in a background task (202).

Path parameters

  • pidstring (uuid)required

Body

  • scopeanyrequired
  • sourcestringcan be null
  • precisioninteger
  • overridebooleancan be null

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.

202 OK

  • jobstring (uuid)required

    The background task: follow it with GET /editor/jobs/{id}/ (/editor/api/v1/jobs/{id}/ with a token).

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