put https://api.safetyculture.io/users/
The Update User
endpoint allows users with the "Platform management: Users" permission to update any of the following user properties:
- username (email address)
- first name
- last name
- status (
active
orinactive
) - seat type (
full
,lite
, orfree
("Guest"), only foractive
users)
Patch semantics are supported, meaning only the fields that are sent in the request are updated.
NOTES:
- To update a user, you must be in the same organization as that user.
- All fields except for the username (email address) will be updated immediately.
- Updating a username (email address) field will trigger a confirmation email.
- Only once the confirmation email has been actioned will the username (email address) be updated.
- When a user is de-activated i.e. their
status
changed fromactive
toinactive
, their access to inspection data they owned or was previously shared with them ceases. - When a user is activated i.e. their
status
is changed frominactive
toactive
, if the organization is on the Premium plan, reactivating the user will default to afull
seat if noseat_type
is passed into the request. Activating a user in afull
seat will fail if the organization has not purchased enoughfull
seats. - Organizations are required to have enough paid
full
seats if they're changing users' seat types tofull
seats. Changing seat types tofull
seats when there aren't enoughfull
seats will be rejected, and the organization will be required to purchase more seats through the SafetyCulture platform.