v1

latestOpenAPI 3.0.32026-08-061874701.5 MB
users

Deactivate user

Deactivates the user associated with the current Smartsheet plan, blocking the user from using Smartsheet in any way. Deactivating a user does not affect their existing permissions on owned or shared items.

Optionally, with Enterprise Plan Manager (EPM) enabled, you can deactivate a user from child organizations.

Who can use this operation?

Permissions: System Admin

This operation is unavailable for Smartsheet Gov.

Attempting to deactivate a user that matches any of the following criteria results in an error:

  • The user's primary email address belongs to an ISP domain (e.g., gmail.com, yahoo.com, outlook.com). For example, see the common ISP domains listed below.
  • The user's primary email address is unassociated with the current Smartsheet plan domain(s).
  • The user is managed by an external source, such as an identity provider (IdP) or directory integration (DI) provider. External source examples include Okta and Azure AD. Deactivating such a user can only be done via the external source.

Users with primary email addresses on the following ISP domains cannot be deactivated:

  • aol.com
  • charter.net
  • comcast.net
  • duck.com
  • email.com
  • gmail.com
  • hotmail.com
  • icloud.com
  • live.com
  • mail.com
  • mail.ru
  • outlook.com
  • rocketmail.com
  • usa.com
  • verizon.net
  • web.de
  • yahoo.com
post/users/{userId}/deactivate

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