Skip to content
TestLookupTestLookup
Search Ctrl K

Search TestLookup

Enter a term to search the local static index.

    Update User Profile — PATCH /api/v1/users/{user_id}

    Update User Profile

    Update a user’s profile attributes. Requires ADMIN. Only non-None fields are applied.

    Endpoint: PATCH /api/v1/users/{user_id}

    Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.

    • Your role must be Admin or higher.
    NameInRequiredTypeDefaultDescription
    user_idpathyesstring (uuid)
    X-API-Keyheadernostring or nullAPI key, as an alternative to the access token (see Authentication).
    Content typeBodyRequired
    application/jsonUpdateUserProfileRequestyes
    StatusMeaningBody
    200Successful ResponseUserListResponse (application/json)
    422Validation ErrorHTTPValidationError (application/json)

    Errors this endpoint returns, read from its source code:

    • 400, with messages such as “Cannot change your own role”, “Cannot deactivate your own account”
    • 404, with the message “User not found”
    • 409, with messages such as “Email already in use”, “Username already in use”

    It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.