Sign in
Users

Update user details

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

Path parameters

idinteger required

User ID

Request body

active_organizationinteger nullable
allow_newslettersboolean nullable

Allow sending newsletters to user

{"stackTrail":"components:schemas:PatchedLseUserSerializerUpdateRequest:properties:custom_hotkeys","oasType":"schema","type":"unknown","description":"Custom keyboard shortcuts configuration for the user interface","nullable":true}
date_joinedstring date-time
{"stackTrail":"components:schemas:PatchedLseUserSerializerUpdateRequest:properties:email_notification_settings","oasType":"schema","type":"unknown"}
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
{"stackTrail":"components:schemas:LseUser:properties:custom_hotkeys","oasType":"schema","type":"unknown","description":"Custom keyboard shortcuts configuration for the user interface","nullable":true}
date_joinedstring date-time
emailstring email
first_namestring
idinteger required
initialsstring required
last_activitystring date-time required
last_namestring
pauseobject nullable required
phonestring
usernamestring required

Changes

Changed in 3 of the 97 revisions of this API.11814

  • e1ba2ecdbabb1810See the full diff
    • ▲

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

      request-property-min-length-increased

    • ●

      the first_name request property's maxLength was set to 256

      request-property-max-length-set

    • ●

      the last_name request property's maxLength was set to 256

      request-property-max-length-set

    • ●

      the phone request property's maxLength was set to 256

      request-property-max-length-set

    • ●

      the username request property's maxLength was set to 256

      request-property-max-length-set

    • ●

      removed the request property avatar

      request-property-removed

    • ●

      removed the request property email

      request-property-removed

    • ●

      removed the request property id

      request-property-removed

    • ●

      removed the request property initials

      request-property-removed

    • ○

      added the new optional request property active_organization

      new-optional-request-property

    • ○

      added the new optional request property custom_hotkeys

      new-optional-request-property

    • ○

      added the new optional request property date_joined

      new-optional-request-property

    • ○

      added the new optional request property email_notification_settings

      new-optional-request-property

    • ○

      added the new optional request property is_email_verified

      new-optional-request-property

    • ○

      added the new optional request property onboarding_state

      new-optional-request-property

    • ○

      added the new optional request property password

      new-optional-request-property

    • ○

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

      request-body-media-type-added

    • ○

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

      request-body-media-type-added

    • ○

      the request property allow_newsletters became nullable

      request-property-became-nullable

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 037e8b19fbfd4See the full diff
    • ○

      added the required property org_membership/items/flex to the response with the 200 status

      response-required-property-added

    • ○

      added the required property org_membership/items/user_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property organization_membership/allOf[OrganizationMembership]/flex to the response with the 200 status

      response-required-property-added

    • ○

      added the required property organization_membership/allOf[OrganizationMembership]/user_type to the response with the 200 status

      response-required-property-added

  • b5f055b9d45b10See the full diff
    • ▲

      the response property avatar became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property lse_fields/allOf[LseFields]/invite_expired became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property lse_fields/allOf[LseFields]/invite_expired_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property pause became nullable for the status 200

      response-property-became-nullable

    • ▲

      the active_organization_meta response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ▲

      the lse_fields/allOf[LseFields]/email_notification_settings response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

    • ▲

      the lse_fields/allOf[LseFields]/invite_expired response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the org_membership/items/active response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the organization_membership/allOf[OrganizationMembership]/active response's property type/format changed from string/ to boolean/ for status 200

      response-property-type-changed

    • ▲

      the pause response's property type/format changed from string/ to object/ for status 200

      response-property-type-changed

Of the 97 revisions, 1 has no diff computed.