Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Favorite Input

A favorite to create or update.
JSON example
1{
2  name: "Most Important Accounts",
3  sortOrder: 1
4  target: "00BR0000000tTTwMAM",
5  targetType: "ListView"
6}
Properties
Name Type Description Required or Optional Available Version
name String The name of the favorite. Required for PATCH if sortOrder isn't specified. You may specify both. 41.0
sortOrder Integer The sort order of the favorite, from 1 to N. Required for PATCH if name is unspecified. You may specify both. 41.0
target String The record, API name, or content being favorited. Required in a POST request. Do not specify in a PATCH request. 41.0
targetType String The type of favorite. One of these values:
  • ListView—A favorited list view.
  • ObjectHome—A favorited object home.
  • Record—A favorited record.
  • Tab—A favorited tab.
Required in a POST request. Do not specify in a PATCH request. 41.0