Pulsarr

Bulk create watchlist exclusions

POST
/v1/watchlist-exclusions/bulk

Exclude several watchlist items for their users, or globally for every user

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Request Body

Watchlist items to exclude in one request. Under the users scope the item and user pairs count against the cap

application/json
  1. body

Watchlist items to exclude in one request. Under the users scope the item and user pairs count against the cap

items*array<>
Items1 <= items <= 1000
scope*WatchlistExclusionScope

users excludes each item for its userIds, global excludes it for every user and ignores userIds

Value in"users""global"

Response Body

Default Response

application/json
  1. response

created and skipped count exclusion rows (skipped already existed), failed lists item keys

success*boolean
message*string
result*
Example Request
curl -X POST 'http://localhost:3003/v1/watchlist-exclusions/bulk' \  -H 'Content-Type: application/json' \  -d '{  "items": [    {      "key": "string",      "userIds": [        0      ],      "title": "string",      "type": "movie"    }  ],  "scope": "users"}'
Example Response
{  "success": true,  "message": "string",  "result": {    "created": 0,    "skipped": 0,    "failed": [      "string"    ],    "errors": [      "string"    ],    "total": 0  }}