Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
users

Update user

Updates attributes of the specified user.

Who can use this operation?

Permissions: System Admin. To modify a user who belongs to a user model organization, you must also be a member of that same organization.

Licensed sheet creator constraints

  • On the user model, you can only update licensedSheetCreator for a System Admin user (admin: true).
  • You can't revoke the licensed sheet creator status (that is, set licensedSheetCreator to false) for a user who is either a Group Admin (groupAdmin: true) or a Resource Viewer (resourceViewer: true).
put/users/{userId}

Request body

adminboolean

Indicates whether the user is a system admin (can manage user accounts and organization account).

licensedSheetCreatorboolean

Indicates whether the user is a licensed user (can create and own sheets).

firstNamestring

User's first name.

lastNamestring

User's last name.

groupAdminboolean

Indicates whether the user is a group admin (can create and edit groups).

resourceViewerboolean

Indicates whether the user is a resource viewer (can access resource views).

Example request

{
  "admin": true,
  "licensedSheetCreator": true,
  "firstName": "Jane",
  "lastName": "Doe",
  "groupAdmin": true,
  "resourceViewer": true
}

Response

Result object containing the User object for the updated user.

message'PARTIAL_SUCCESS' | 'SUCCESS'

Message that indicates the outcome of the request. (One of SUCCESS or PARTIAL_SUCCESS.)

resultCode0 | 3
  • '0' Success
  • '3' Partial Success of Bulk Operation

Example response

{
  "message": "SUCCESS",
  "data": [
    {
      "email": "jane.doe@smartsheet.com",
      "name": "Jane Doe",
      "firstName": "Jane",
      "lastName": "Doe",
      "profileImage": {
        "imageId": "u!1!nAtdn5RJB_o!k6_e_3h2R3w!wmYXPek-yVD",
        "height": 1050,
        "width": 1050
      },
      "id": 48569348493401200
    }
  ]
}