Pulsarr

Update user

PATCH
/v1/users/{id}

Update an existing user by ID

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

Path Parameters

id*integer
Range0 < value <= 9007199254740991

Request Body

application/json
  1. body
name?string
Length3 <= length <= 255
apprise?string|null
alias?|null
discord_id?|null
notify_apprise?boolean
notify_discord?boolean
notify_discord_mention?boolean
notify_plex_mobile?boolean
can_sync?boolean
requires_approval?boolean

Response Body

Default Response

application/json
  1. response
success*boolean
message*string
user*

User with their Plex friend status, null when Plex cannot classify them

Example Request
curl -X PATCH 'http://localhost:3003/v1/users/1' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "success": true,  "message": "string",  "user": {    "id": 0,    "name": "string",    "apprise": "string",    "alias": "string",    "discord_id": "string",    "notify_apprise": true,    "notify_discord": true,    "notify_discord_mention": true,    "notify_plex_mobile": true,    "can_sync": true,    "requires_approval": true,    "is_primary_token": true,    "plex_uuid": "string",    "avatar": "string",    "display_name": "string",    "friend_created_at": "string",    "created_at": "string",    "updated_at": "string",    "friendStatus": "friend",    "pendingSince": "string"  }}