Change the categories of many customers

POST/editor/playlists/{pid}/users/bulk-categories/

write Change: creates or edits. Scopes

Adds, removes or sets (mode: "overwrite") categories of the customers ids. live, movie and series are category ids; add and remove leave a kind without ids as it is, overwrite sets every kind given (an empty list: none). Answers how many customers it changed.

Path parameters

pidstring (uuid)required

Body

idsinteger[]required
modestringrequired
- add - add
- remove - remove
- overwrite - overwrite
One of: "add" "remove" "overwrite"
liveinteger[]can be null
movieinteger[]can be null
seriesinteger[]can be null

Response

200 OK

changedintegerrequired

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

cURL

curl -X POST 'https://panel.example.com/editor/playlists/1/users/bulk-categories/' \
  -H "Authorization: Bearer $MINIMUS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    1
  ],
  "mode": "add"
}'

Python

import os
import requests

response = requests.post(
    "https://panel.example.com/editor/playlists/1/users/bulk-categories/",
    headers={"Authorization": f"Bearer {os.environ['MINIMUS_API_KEY']}"},
    json={
        "ids": [
            1
        ],
        "mode": "add"
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const response = await fetch('https://panel.example.com/editor/playlists/1/users/bulk-categories/', {
  method: 'POST',
  headers: { Authorization: `Bearer ${process.env.MINIMUS_API_KEY}`, 'Content-Type': 'application/json' },
  body: JSON.stringify({
    "ids": [
      1
    ],
    "mode": "add"
  }),
});
if (!response.ok) throw new Error(`${response.status}`);
console.log(await response.json());

Response 200

{
  "changed": 1
}

Change the categories of many customers

Path parameters#

Body#

Response#

200 OK

Errors#

Path parameters

Body

Response

Errors