Appearance
Update User
Update a users information
- You can only update the email address if the users authentication is linked with this target record. This is for when a user has access to multiple tenants / organizations, updating email there will not update the email the user will login with.
- Use the other api's to update users active status, or permissions.
Parameters
| name | type | data type | description |
|---|---|---|---|
targetPath | required | string | the path to the organization or tenant where the user record 'lives' |
userId | required | string | the user id of the user record you would like to enid |
body.user | required | UserType | the data in the user object you would like te set |
Return Value
JSON object of type user record
Examples
bash
curl -X PUT -H "Authentication: ZmFrZQ==" https://app.wombat.software/api/{targetPath}/user/:userId -d "{
"user": {
"metadata": {
"firstName": "morgoth"
}
}
}"ENDPOINTS
put
/api/{targetPath}/user/:userId