Update a user

Last updated
Save as PDF

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

{
  "firstName": "SomeOne",
  "lastName": "Else",
  "timeZone": "America/New_York",
  "enabled": "false",
  "administrator": true,
  "boardCreator": true,
  "dateFormat": "MM/dd/yyyy",
  "licenseType": "full"
}

Example Successful Response

200 Success

{
  "id": "10113041625",
  "username": "someone@mycompany.com",
  "firstName": "SomeOne",
  "lastName": "Else",
  "fullName": "SomeOne Else",
  "emailAddress": "someone@mycompany.com",
  "lastAccess": null,
  "dateFormat": "MM/dd/yyyy",
  "administrator": true,
  "enabled": false,
  "deleted": false,
  "organizationId": "10187654101",
  "boardCreator": true,
  "timeZone": "America/New_York",
  "licenseType": "full",
  "externalUserName": null,
  "avatar": "https://bigfood.localkanban.com/avatar/show/10113041625/?s=25",
  "settings": {},
  "boardRoles": [
      {
          "boardId": "10100000505",
          "WIP": null,
          "role": {
              "key": "boardReader",
              "value": 1,
              "label": "Reader"
          }
      }
  ]
}

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