Click or drag to resize

FavoriteResourcesRemoveFavorites Method

Removes one or multiple objects from the user’s list of Favorite items.

It mirrors to the following Smartsheet REST API methods:

  • DELETE /favorites/folder
  • DELETE /favorites/report
  • DELETE /favorites/sheet
  • DELETE /favorites/template
  • DELETE /favorites/workspace

Namespace:  Smartsheet.Api
Assemblies:   smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
  smartsheet-csharp-sdk (in smartsheet-csharp-sdk.dll) Version: 2.126.0
Syntax
Copy
void RemoveFavorites(
	ObjectType type,
	IList<long> objectIds
)

Parameters

type
Type: Smartsheet.Api.ModelsObjectType
the object type to remove
objectIds
Type: System.Collections.GenericIListInt64
(required): object IDs representing the items to remove from Favorites. If type is "template", only private sheet-type template ID is allowed.
Exceptions
ExceptionCondition
InvalidOperationException if any argument is null or empty string
InvalidRequestException if there is any problem with the REST API request
AuthorizationException if there is any problem with the REST API authorization (access token)
ResourceNotFoundException if the resource cannot be found
ServiceUnavailableException if the REST API service is not available (possibly due to rate limiting)
SmartsheetException if there is any other error during the operation
See Also