v51

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-014430130.6 KB

users

Update a user

put/users/{userId}

Path parameters

userIdstring required

The ID of the user which this request is targeting.

Request body

emailstring required

The email address of the user, this must be unique.

passwordstring

The password of the user if using password based login - this will never be returned. This can be left out of subsequent requests (updates) and will be enriched back into the user structure.

status'active'

The status of the user, if they are active.

firstNamestring

The first name of the user

lastNamestring

The last name of the user

forceResetPasswordboolean

If set to true forces the user to reset their password on first login.

rolesobject

Contains the roles of the user per app (assuming they are not a builder user). This field can only be set on a business or enterprise license.

Response

Returns the updated user.