---
schema_version: "1"
id: be72481ff214a1b604276a712353251b3a1b0169b4a1c7d6397f9a12528f53e9
title: Create a Favorite
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_resources_favorites_create.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_create.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 5cc9a6ed18d1aa74d3b95478a844c04ac321083bb5527a2062b828720b9c3c0d
description: Create a favorite.
---
# Create a Favorite

Create a favorite.

Resource

/ui-api/favorites

Available Version

41.0

HTTP Method

POST

Example

POST /ui-api/favorites/

{
  name: "Most Important Accounts",
  sortOrder: 1
  target: "00BR0000000tTTwMAM",
  targetType: "ListView"
}

Request Parameters

<table class="featureTable sort_table" summary="">





              <thead class="thead sorted" align="left">
                <tr>
                  <th class="featureTableHeader vertical-align-top " id="d43950e105">Name</th>

                  <th class="featureTableHeader vertical-align-top " id="d43950e108">Type</th>

                  <th class="featureTableHeader vertical-align-top " id="d43950e111">Description</th>

                  <th class="featureTableHeader vertical-align-top " id="d43950e114">Required or Optional</th>

                  <th class="featureTableHeader vertical-align-top " id="d43950e117">Available Version</th>

                </tr>

              </thead>

              <tbody class="tbody">
                <tr>
                  <td class="entry" headers="d43950e105" data-title="Name"><samp class="codeph nolang">name</samp></td>

                  <td class="entry" headers="d43950e108" data-title="Type">String</td>

                  <td class="entry" headers="d43950e111" data-title="Description">The name of the favorite.</td>

                  <td class="entry" headers="d43950e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d43950e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d43950e105" data-title="Name"><samp class="codeph nolang">sortOrder</samp></td>

                  <td class="entry" headers="d43950e108" data-title="Type">Integer</td>

                  <td class="entry" headers="d43950e111" data-title="Description">The sort order of the favorite, from 1 to N.</td>

                  <td class="entry" headers="d43950e114" data-title="Required or Optional">Optional</td>

                  <td class="entry" headers="d43950e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d43950e105" data-title="Name"><samp class="codeph nolang">target</samp></td>

                  <td class="entry" headers="d43950e108" data-title="Type">String</td>

                  <td class="entry" headers="d43950e111" data-title="Description">The record, API name, or content being favorited.</td>

                  <td class="entry" headers="d43950e114" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d43950e117" data-title="Available Version">41.0</td>

                </tr>

                <tr>
                  <td class="entry" headers="d43950e105" data-title="Name"><samp class="codeph nolang">targetType</samp></td>

                  <td class="entry" headers="d43950e108" data-title="Type">String</td>

                  <td class="entry" headers="d43950e111" data-title="Description">The type of favorite. One of these values:<ul class="ul bulletList">
                      <li class="li">
                        <samp class="codeph nolang">ListView</samp>—A favorited list
                        view.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">ObjectHome</samp>—A favorited object
                        home.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Record</samp>—A favorited record.
                      </li>

                      <li class="li">
                        <samp class="codeph nolang">Tab</samp>—A favorited tab.
                      </li>

                    </ul>

                  </td>

                  <td class="entry" headers="d43950e114" data-title="Required or Optional">Required</td>

                  <td class="entry" headers="d43950e117" data-title="Available Version">41.0</td>

                </tr>

              </tbody>

            </table>

Request Body

[Favorite Input](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_input.htm "A favorite to create or update.")

Response Body

[Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_responses_favorite.htm#ui_api_responses_favorite "A single favorite.")