Favority Folders represent folders users selected as favorites in the user's account. [Deprecated] Use the Favorites API instead.

Get List of FavoriteFolders

GET https://account.sf-api.com/sf/v3/Users(id)/FavoriteFolders

GET https://account.sf-api.com/sf/v3/Users/FavoriteFolders

Retrieves the list of Favorite folders for a given user.

String

User identifier - default is logged in user

Returns: A list of Favorite Folders specified by this user

Get FavoriteFolder

GET https://account.sf-api.com/sf/v3/Users(userid)/FavoriteFolders(itemid)

GET https://account.sf-api.com/sf/v3/Users/FavoriteFolders(itemid)

Retrieves a single Favorite Folder

userid	String	User identifier - default is logged in user
itemid	String	Item identifier

Returns: A list of Favorite Folders specified by this user

Get Item as Favorite Folder

GET https://account.sf-api.com/sf/v3/Items(parentid)/FavoriteFolder

Retrieves a Favorite Folder representation of a given parent Item

parentid

String

Parent Item identifier

Returns: The specified Favorite Folder if it belongs to the specified parent Item

Get FavoriteFolder

GET https://account.sf-api.com/sf/v3/FavoriteFolders(userid=userid,itemid=itemid)

Retrieve a single Favorite Folder from a give user

userid	String	The user identifier. Default is the authenticated user
itemid	String	The item identifier

Returns: The selected Favorite Folder

Create FavoriteFolder

POST https://account.sf-api.com/sf/v3/Users(id)/FavoriteFolders

POST https://account.sf-api.com/sf/v3/Users/FavoriteFolders 
            { 
              "Folder": { "Id":"fo96aec5-d637-4124-bcc9-c86fd7301e4d" }, 
              "FolderAlias" : "alias" 
            }

Adds an existing folder to the list of favorites of a given user.

id	String	User identifier. Default is logged in user.
folder	FavoriteFolder	Folder identifier. Only the Id parameter of this object is used, other settings are ignored.

Returns: A new FavoriteFolder record

Create or Update FavoriteFolders

PUT https://account.sf-api.com/sf/v3/Users(id)/FavoriteFolders

PUT https://account.sf-api.com/sf/v3/Users/FavoriteFolders 
            [{ 
                Folder: { 
                    "Id":"fo96aec5-d637-4124-bcc9-c86fd7301e4d" 
                } 
            }]

Replaces existing favorite folders with the folders provided. Any exisitng folders that are not specified will be removed.

id	String	User identifier. Default is logged in user.
favoriteFolderList	FavoriteFolder[]	Folders identifier. Only the Id parameter of the folder object is used, other settings are ignored.

Delete FavoriteFolder

DELETE https://account.sf-api.com/sf/v3/Users(id)/FavoriteFolders(itemid)

DELETE https://account.sf-api.com/sf/v3/Users/FavoriteFolders(itemid)

Removes a favorite folder from a user's list.

id	String	User identifier. Default is current logged in user
itemid	String	Item identifier