User Interface API Developer Guide

Get Started with User Interface API
User Interface API Features
User Interface API Resources
User Interface API Request Bodies
Action Input
Action Related List Single Batch Input
Action Related Lists Batch Input
Batch Record Input
Content Input
Batch Operation Input
Favorite Batch Collection Input
Favorite Batch Input
Favorite Input
List Filter By Info Input
List Info Input
List Info Post Input
List Order By Input
List Preferences Input
List Records Input
List Scope Input
List User Preference Input
Lookup Post Input
Navigation Item Collection Input
Navigation Item Input
Page Reference Input
Perform Action Input
Record Input
Related List Input
Related List Records Input
Related List Records Batch Input
Related List User Preferences Input
User Interface API Response Bodies
User Interface API Appendices
PDF

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