---
schema_version: "1"
id: 35c58ed4b708f99d378d07ae2c6b7414043aa73c83bf2264cd0ac2ec2c0b8dc3
title: Favorite Input
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/uiapi/ui_api_requests_favorite_input.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_requests_favorite_input.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 429a9e7b150c31a21b9805522146d8cc5120063a8ef6ea16160b9412d148cd48
description: A favorite to create or update.
---
# Favorite Input

A favorite to create or update.

JSON example

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

Properties

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





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

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

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

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

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

                </tr>

              </thead>

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

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

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

                  <td class="entry" headers="d22661e68" data-title="Required or Optional">Required for PATCH if <samp class="codeph nolang">sortOrder</samp>
                    isn't specified. You may specify both.</td>

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

                </tr>

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

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

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

                  <td class="entry" headers="d22661e68" data-title="Required or Optional">Required for PATCH if <samp class="codeph nolang">name</samp> is
                    unspecified. You may specify both.</td>

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

                </tr>

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

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

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

                  <td class="entry" headers="d22661e68" data-title="Required or Optional">Required in a POST request. Do not specify in a PATCH request.</td>

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

                </tr>

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

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

                  <td class="entry" headers="d22661e65" 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="d22661e68" data-title="Required or Optional">Required in a POST request. Do not specify in a PATCH request.</td>

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

                </tr>

              </tbody>

            </table>

#### See Also

- [Create a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorites_create.htm "Create a favorite.")
- [Update a Favorite](https://developer.salesforce.com/docs/atlas.en-us.uiapi.meta/uiapi/ui_api_resources_favorite_update.htm "Update a favorite.")