Create a Favorite

Create a favorite.

Resource

1/ui-api/favorites

Available Version

41.0

HTTP Method

POST

Request Body

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.	You must specify either `name` or `sortOrder`. You may specify both.	41.0
`sortOrder`	Integer	The sort order of the favorite, from 1 to N.	You must specify either `name` or `sortOrder`. 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

Request Parameters

Name	Type	Description	Required or Optional	Available Version
`name`	String	The name of the favorite.	Optional	41.0
`sortOrder`	Integer	The sort order of the favorite, from 1 to N.	Optional	41.0
`target`	String	The record, API name, or content being favorited.	Required	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	41.0

Response Body for POST

Favorite

User Interface API Developer Guide