DELETE /users/{userId}
Removes a user from an organization account. User is transitioned to a free collaborator with read-only access to owned reports, sheets, Sights, workspaces, and any shared templates (unless those are optionally transferred to another user).
-
This operation is only available to system administrators
-
If the transferTo parameter is specified and the removed user owns groups, the user specified via the transferTo parameter must have group admin rights.
-
The transferTo and transferSheets parameters cannot be specified for a user who has not yet accepted an invitation to join the organization account (that is, if user status=PENDING).
Servers
- https://api.smartsheet.com/2.0
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
transferTo |
Number | No |
(Required if user owns groups.)
|
transferSheets |
Boolean | No |
Default value: false |
removeFromSharing |
Boolean | No |
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.