---
title: "Add favorites"
method: POST
path: "/favorites"
tags: ["favorites"]
---

# Add favorites

`POST /favorites`

Adds one or more favorite items for the current user. This operation supports both single-object and bulk semantics. For more information, see Optional Bulk Operations.
If called with a single Favorite object, and that favorite already exists, error code 1129 is returned. If called with an array of Favorite objects, any objects specified in the array that are already marked as favorites are ignored and omitted from the response.

## Headers

- `Content-Type` string

## Request body

- union
  - Favorite
    - `objectId` number — The ID of the favorited item. If type is template, only private sheet-type template ID is allowed.
    - `type` 'folder' | 'report' | 'sheet' | 'sight' | 'template' | 'workspace'
  - Favorite[]
    - `objectId` number — The ID of the favorited item. If type is template, only private sheet-type template ID is allowed.
    - `type` 'folder' | 'report' | 'sheet' | 'sight' | 'template' | 'workspace'

## Response `200`

Result object containing either a single Favorite object or an array of Favorite objects.

- object
  - `message` 'PARTIAL_SUCCESS' | 'SUCCESS' — Message that indicates the outcome of the request. (One of `SUCCESS` or `PARTIAL_SUCCESS`.)
  - `resultCode` 0 | 3 — * '0' Success * '3' Partial Success of Bulk Operation
  - `result` union
    - Favorite
      - `objectId` number — The ID of the favorited item. If type is template, only private sheet-type template ID is allowed.
      - `type` 'folder' | 'report' | 'sheet' | 'sight' | 'template' | 'workspace'
    - Favorite[]
      - `objectId` number — The ID of the favorited item. If type is template, only private sheet-type template ID is allowed.
      - `type` 'folder' | 'report' | 'sheet' | 'sight' | 'template' | 'workspace'

## Other responses

- `default` — Generic Error Payload.

---

[API](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference.md) · [All operations](https://skmtc.net/smartsheet/apis/smartsheet-openapi-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smartsheet/smartsheet-openapi-reference/versions/b4afda95fb51/schema)