Update a user
PATCH /io/user/:userId
Update an existing user.
Requires account administrator access.
Request Properties
Param |
Type |
Usage |
Default |
emailAddress |
string |
|
|
firstName |
string |
|
|
lastName |
string |
|
|
timeZone |
string |
See valid timezones. |
Etc/GMT |
enabled |
boolean |
|
true |
administrator |
boolean |
|
false |
boardCreator |
boolean |
|
false |
dateFormat |
enumeration |
Values:
MM/dd/yyyy
dd/MM/yyyy
yyyy/MM/dd |
MM/dd/yyyy |
licenseType |
enumeration |
Only available if reader users are enabled for the account. Possible values:
full
reader |
full |
externalUserName |
string |
|
|
Example Request
02 | "firstName" : "SomeOne" , |
04 | "timeZone" : "America/New_York" , |
06 | "administrator" : true , |
08 | "dateFormat" : "MM/dd/yyyy" , |
Example Successful Response
200 Success
03 | "username" : "someone@mycompany.com" , |
04 | "firstName" : "SomeOne" , |
06 | "fullName" : "SomeOne Else" , |
07 | "emailAddress" : "someone@mycompany.com" , |
09 | "dateFormat" : "MM/dd/yyyy" , |
10 | "administrator" : true , |
13 | "organizationId" : "10187654101" , |
15 | "timeZone" : "America/New_York" , |
16 | "licenseType" : "full" , |
17 | "externalUserName" : null , |
22 | "boardId" : "10100000505" , |
Response Properties
Property |
Type |
Note |
id |
string id |
|
username |
string |
|
firstName |
string |
|
lastName |
string |
|
fullName |
string |
|
emailAddress |
string |
|
lastAccess |
date |
|
dateFormat |
string |
|
administrator |
boolean |
|
enabled |
boolean |
|
deleted |
boolean |
|
organizationId |
string |
|
boardCreator |
boolean |
|
timeZone |
string |
|
licenseType |
string |
full or reader . Only present if reader is enabled for the account |
externalUserName |
string |
|
avatar |
string |
|
settings |
object |
Contains a key/value hash of user settings |
boardRoles |
array |
Contains the user's access information for the organization's boards |