Sign in

v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
users

Add user

Adds a user to the organization account.

Who can use this operation?

Permissions: System Admin

If successful, and user auto provisioning (UAP) is on, and user matches the auto provisioning rules, user is added to the org. If UAP is off, or user does not match UAP rules, user is invited to the org and must explicitly accept the invitation to join.

Note: On user model plans, this operation sets licensedSheetCreator to true, regardless of the value provided in the request body.

Note: In some specific scenarios, supplied attributes such as firstName and lastName may be ignored. For example, if you are inviting an existing Smartsheet user to join your organization account, and the invited user has not yet accepted your invitation, any supplied firstName and lastName are ignored.

post/users

Query parameters

sendEmailboolean

Either true or false to indicate whether to notify the user by email. Default is false. If true, limit is 1000 emails.

Request body

idnumber

User ID.

adminboolean

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

customWelcomeScreenViewedstring date-time

Timestamp of viewing an Enterprise Custom Welcome Screen by the current user.

emailstring email

User's primary email address.

firstNamestring

User's first name.

groupAdminboolean

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

isInternalboolean

Indicates whether the user is internal to the plan's domain.

Note: It's present only when a planId query parameter is supplied.

lastLoginstring date-time

The timestamp of the user's last login to Smartsheet.

This property is only included in the response when all of the following conditions are met:

  • The include=lastLogin query parameter is present
  • The user has logged in to Smartsheet at least once
  • The caller has System Admin permissions
  • The total number of users in the response is 100 or fewer

This property is excluded from the response if any of the following conditions apply:

  • The includeAll=true query parameter is present
  • The planId query parameter is present
  • The seatType query parameter is present
  • The pageSize query parameter is set to a value greater than 100
lastNamestring

User's last name.

licensedSheetCreatorboolean

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

Note: On user model plans, the POST /users operation sets licensedSheetCreator to true, regardless of the value provided in the request body.

namestring

User's full name (read-only).

provisionalExpirationDatestring date-time nullable

The expiration timestamp of the user's provisional seat type. It's null if the user doesn't have a PROVISIONAL_MEMBER seat type.

Note: It's present only when a planId query parameter is supplied.

resourceViewerboolean

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

seatType'MEMBER' | 'PROVISIONAL_MEMBER' | 'CONTRIBUTOR' | 'GUEST' | 'VIEWER'

User's seat type.

Note: It's only present when either or both the planId and seatType query parameters are supplied (available to system admins only).

DEPRECATED - As early as the sunset date specified in this changelog entry, VIEWER will be removed and replaced by CONTRIBUTOR for all free-tier plans users. Commenting and attachments are free to the CONTRIBUTOR seat type.

seatTypeLastChangedAtstring date-time

Timestamp of the user's last seat type change.

Note: It's only present when either or both the planId and seatType query parameters are supplied (available to system admins only).

sheetCountnumber

SUNSET - The sheetCount attribute now holds the value -1 and is included only if the retrieved user's status is ACTIVE.

status'ACTIVE' | 'DECLINED' | 'PENDING' | 'DEACTIVATED'

User status, set to one of the listed enum values.

Example request

{
  "id": 48569348493401200,
  "admin": true,
  "customWelcomeScreenViewed": "2020-08-25T12:15:47Z",
  "email": "jane.doe@smartsheet.com",
  "firstName": "Jane",
  "groupAdmin": true,
  "isInternal": true,
  "lastLogin": "2020-10-04T18:32:47Z",
  "lastName": "Doe",
  "licensedSheetCreator": true,
  "name": "Jane Doe",
  "profileImage": {
    "imageId": "u!1!nAtdn5RJB_o!k6_e_3h2R3w!wmYXPek-yVD",
    "height": 1050,
    "width": 1050
  },
  "provisionalExpirationDate": "2025-06-14T09:55:30Z",
  "resourceViewer": true,
  "seatType": "PROVISIONAL_MEMBER",
  "seatTypeLastChangedAt": "2025-06-14T09:55:30Z",
  "sheetCount": -1,
  "status": "ACTIVE"
}

Response

Result object containing the newly created User object.

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",
  "result": {
    "id": 48569348493401200,
    "admin": true,
    "customWelcomeScreenViewed": "2020-08-25T12:15:47Z",
    "email": "jane.doe@smartsheet.com",
    "firstName": "Jane",
    "groupAdmin": true,
    "isInternal": true,
    "lastLogin": "2020-10-04T18:32:47Z",
    "lastName": "Doe",
    "licensedSheetCreator": true,
    "name": "Jane Doe",
    "profileImage": {
      "imageId": "u!1!nAtdn5RJB_o!k6_e_3h2R3w!wmYXPek-yVD",
      "height": 1050,
      "width": 1050
    },
    "provisionalExpirationDate": "2025-06-14T09:55:30Z",
    "resourceViewer": true,
    "seatType": "PROVISIONAL_MEMBER",
    "seatTypeLastChangedAt": "2025-06-14T09:55:30Z",
    "sheetCount": -1,
    "status": "ACTIVE"
  }
}