Users

Update user details

Changed on 
    Update details for a specific user, such as their name or contact information, in Label Studio.
patch/api/users/{id}/

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/users/{id}/
  • Auth
    API key in header Authorization

Path parameters

idinteger required

User ID

Request body

active_organizationinteger nullable
allow_newslettersboolean nullable

Allow sending newsletters to user

custom_hotkeysunknown
date_joinedstring date-time
email_notification_settingsunknown
first_namestring
is_email_verifiedboolean nullable
last_namestring
onboarding_statestring nullable
passwordstring
phonestring
usernamestring

Response

active_organizationinteger nullable
active_organization_metaobject required
allow_newslettersboolean nullable

Allow sending newsletters to user

avatarstring nullable required
custom_hotkeysunknown
date_joinedstring date-time
emailstring email
first_namestring
idinteger required
initialsstring required
last_activitystring date-time nullable required
last_namestring
pauseobject nullable required
phonestring
usernamestring required

Changes

  • bd1d84db7b4dRevision changes
    • breaking

      the response property became nullable for the status

  • e1ba2ecdbabbRevision changes
    • breaking

      the request property's minLength was increased from 0 to 1

    • warning

      the request property's maxLength was set to 256

    • warning

      the request property's maxLength was set to 256

    • warning

      the request property's maxLength was set to 256

    • warning

      the request property's maxLength was set to 256

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the media type application/x-www-form-urlencoded to the request body

    • info

      added the media type multipart/form-data to the request body

    • info

      the request property became nullable