v38

latestOpenAPI 3.0.3AGPL-3.0raw.githubusercontent.com2026-08-022461333.9 MB
Users

Edit a user (Admin)

Update an existing user.

patch/users/{user_id}

Path parameters

user_idstring required

Unique identifier of the user.

Query parameters

passwordstring

Deprecated: for privacy, send this in a form or JSON request body instead of the query string (query values land in server/proxy logs and browser history). Query-string support will be removed in API9.

emailstring
fullnamestring
websitestring
statestring
citystring
disable0 | 1
groupinteger
maxbitratestring

Maximum transcode bitrate for the user, in bits per second (e.g 320000 = 320Kb). API6 and older take this value in kbps.

fullname_public0 | 1
reset_apikey0 | 1
reset_streamtoken0 | 1
clear_stats0 | 1

Request body

passwordstring

Deprecated: for privacy, send this in a form or JSON request body instead of the query string (query values land in server/proxy logs and browser history). Query-string support will be removed in API9.

emailstring
fullnamestring
websitestring
statestring
citystring
disable0 | 1
groupinteger
maxbitratestring

Maximum transcode bitrate for the user, in bits per second (e.g 320000 = 320Kb). API6 and older take this value in kbps.

fullname_public0 | 1
reset_apikey0 | 1
reset_streamtoken0 | 1
clear_stats0 | 1

Response

Updated

successstring