SMsmartsheet
users

Upgrade user

Upgrades the user associated with the specified Smartsheet plan.

A user can be upgraded to the following seat types:

  • GUEST - only external users can be upgraded to this seat type.
  • MEMBER

Who can use this operation?

Permissions: System Admin

Note: Upgrading a user to its current seat type returns 200 OK.

post/users/{userId}/plans/{planId}/upgrade

Request

  • Base URL
    https://api.smartsheet.com/2.0
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.smartsheet.com/b/authorize
      Token URL: https://api.smartsheet.com/2.0/token scopes: ADMIN_USERS

Request body

seatType'GUEST' | 'MEMBER'

User's seat type.

Example request

{
  "seatType": "MEMBER"
}

Response

Returns the result 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"
}

Changes

No recorded changes to this operation across all 16 revisions of this API.