Set the sorting rules for imports

PUT/streams/sort/rules/

write Change: creates or edits. Scopes

Replaces the rules that sort what playlist imports add; an empty list stops sorting them. Panel operators only. Each rule matches names that start with, contain or end with text and puts them in category, or in a category named new_category made for it. With unlist_old (the default) a stream leaves the category it was in.

Body

rulesobject[]required
- matchstring
  Default: "starts"
- textstringrequired
- categorystring (uuid)can be null
- new_categorystring

Response

200 OK

rulesobject[]required
- matchstringrequired
  - starts - starts
  - contains - contains
  - ends - ends
  - pattern - pattern
  One of: "starts" "contains" "ends" "pattern"
- textstringrequired
- categorystring (uuid)required
- category_namestringrequiredread-only

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.
429 Slow down: wait the seconds in the Retry-After header, then try again.

What each error means

cURL

curl -X PUT 'https://panel.example.com/streams/sort/rules/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "rules": [
    {
      "text": "string"
    }
  ]
}'

Python

import os
import requests

response = requests.put(
    "https://panel.example.com/streams/sort/rules/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
    json={
        "rules": [
            {
                "text": "string"
            }
        ]
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/streams/sort/rules/', {
  method: 'PUT',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "rules": [
      {
        "text": "string"
      }
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "rules": [
    {
      "match": "starts",
      "text": "string",
      "category": "3f2b8c1e-5a4d-4e6f-9b7a-1c2d3e4f5a6b",
      "category_name": "string"
    }
  ]
}

Set the sorting rules for imports

Body#

Response#

200 OK

Errors#

Body

Response

Errors