Run a bulk tool
/editor/playlists/{pid}/tools/{kind}/{tool}/write Change: creates or edits. Scopes
Runs a tool on the rows of scope as one change, or with preview: true only lists what would change (the first 500 differences). target: "categories" works on category names instead (optimize, replace, affix and case only). Each tool takes its own options: optimize tidies names, replace searches and replaces in names, addresses or logos, dedupe sends duplicate channels to the recycle bin, affix adds or removes a prefix or suffix, case changes the case, url replaces text in addresses or logos, format rewrites the channel addresses of a provider login in another stream format, and preset runs a saved preset (or steps).
Path parameters
kindstringrequiredWhich list of the playlist:
live(channels),movie(movies) orseries(TV shows).One of:
"live""movie""series"pidstring (uuid)requiredThe playlist's id.
toolstringrequiredThe tool to run.
One of:
"affix""case""dedupe""format""optimize""preset""replace""url"
Body
scopeobjectrequired{"ids": […]},{"categories": […]}or{"all": true}.idsinteger[]categoriesinteger[]allboolean
optionsobjectThe options of the tool in the path.
targetstringDefault:
"entries"previewbooleanDefault:
false
Response
200 OK
object
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.