Users

Update user details

PATCH

Update details for a specific Label Studio user, such as their name or contact information.

You will need to provide their user ID. You can find a list of all user IDs using List users.

Path parameters

idintegerRequired
User ID

Request

This endpoint expects an object.
id
integerOptional
User ID
first_name
stringOptional
First name of the user
last_name
stringOptional
Last name of the user
username
stringOptional
Username of the user
email
stringOptional
Email of the user
avatar
stringOptional
Avatar URL of the user
initials
stringOptional
Initials of the user
phone
stringOptional
Phone number of the user
allow_newsletters
booleanOptional
Whether the user allows newsletters

Response

This endpoint returns an object
username
string
id
integerOptional
first_name
stringOptional
last_name
stringOptional
email
stringOptional
last_activity
datetimeOptional
avatar
stringOptional
initials
stringOptional
phone
stringOptional
active_organization
integerOptional
allow_newsletters
booleanOptional
Allow sending newsletters to user
PATCH
1curl -X PATCH http://localhost:8080/api/users/1/ \
2 -H "Authorization: Token <api_key>" \
3 -H "Content-Type: application/json" \
4 -d '{}'
200Updated
1{
2 "username": "username",
3 "id": 1,
4 "first_name": "first_name",
5 "last_name": "last_name",
6 "email": "email",
7 "last_activity": "2024-01-15T09:30:00Z",
8 "avatar": "avatar",
9 "initials": "initials",
10 "phone": "phone",
11 "active_organization": 1,
12 "allow_newsletters": true
13}