Update user details

PATCH

http://localhost:8000/api/users/:id/

PATCH

/api/users/:id/

$ curl -X PATCH http://localhost:8000/api/users/1/ \
>      -H "Authorization: Token  <api_key>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

200Updated

1 {
2   "active_organization_meta": {},
3   "avatar": "string",
4   "id": 1,
5   "initials": "?",
6   "last_activity": "2024-01-15T09:30:00Z",
7   "lse_fields": {
8     "email_notification_settings": {},
9     "invite_expired": true,
10     "invite_expired_at": "2024-01-15T09:30:00Z",
11     "invite_activated": true,
12     "invited_at": "2024-01-15T09:30:00Z",
13     "invited_by": 1,
14     "onboarding_state": "not_started",
15     "social_auth_finished": true,
16     "trial_company": "string",
17     "trial_experience_labeling": "string",
18     "trial_license_enterprise": true,
19     "trial_models_in_production": "string",
20     "trial_role": "annotator"
21   },
22   "organization_membership": {
23     "active": true,
24     "flex": {},
25     "organization_id": 1,
26     "role": "string",
27     "user_type": "string"
28   },
29   "pause": {},
30   "username": "string",
31   "org_membership": [
32     {
33       "active": true,
34       "flex": {},
35       "organization_id": 1,
36       "role": "string",
37       "user_type": "string"
38     }
39   ],
40   "active_organization": 1,
41   "allow_newsletters": true,
42   "custom_hotkeys": null,
43   "date_joined": "2024-01-15T09:30:00Z",
44   "email": "string",
45   "first_name": "string",
46   "last_name": "string",
47   "phone": "string"
48 }

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

Authentication

AuthorizationToken

The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

User ID

Request

This endpoint expects an object.

active_organizationinteger or nullOptional

allow_newslettersboolean or nullOptional

Allow sending newsletters to user

custom_hotkeysany or nullOptional

Custom keyboard shortcuts configuration for the user interface

date_joineddatetimeOptional

email_notification_settingsanyOptional

first_namestringOptional<=256 characters

is_email_verifiedboolean or nullOptional

last_namestringOptional<=256 characters

onboarding_statestring or nullOptional>=1 character

passwordstringOptional>=1 character

phonestringOptional<=256 characters

usernamestringOptional1-256 characters

Response

active_organization_metamap from strings to stringsRead-only

avatarstring or nullRead-only

idintegerRead-only

initialsstringRead-onlyDefaults to ?

last_activitydatetimeRead-only

lse_fieldsobject

organization_membershipobject

pausemap from strings to any or nullRead-only

usernamestring<=256 characters

org_membershiplist of objectsRead-onlyDeprecated