v1

latestOpenAPI 3.0.32026-08-061874701.5 MB

users

Downgrade user

Downgrades the user associated with the specified Smartsheet plan. Downgrading a user does not affect their existing permissions on owned or shared items.

A user can be downgraded to the following seat types:

GUEST - only external users can be downgraded to this seat type.
CONTRIBUTOR
VIEWER (Deprecated, use CONTRIBUTOR instead)

Who can use this operation?

Permissions: System Admin

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

Request body

seatType'GUEST' | 'CONTRIBUTOR' | 'VIEWER' required

User's seat type.

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.

Example request

{
  "seatType": "CONTRIBUTOR"
}

Response

Returns the result object..

Downgrading a user to its current seat type returns 200 OK.

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"
}