SMsmartsheet
users

Remove user from plan

Deactivates the user's membership to the plan. In the plan, the user maintains ownership of items but has read-only access to those items and shared items.

Important: This operation is unavailable to legacy plans. Calling this operation for a legacy plan results in an error.

delete/users/{userId}/plans/{planId}

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

Response

Returns 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.