Skip to main content
POST
Create a favorite

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

x-tenant-id
string
required

The organization ID the request is scoped to.

Body

application/json

Request body for creating a favorite.

name
string
required

Display name for the favorite.

icon
string
required

Icon identifier for the favorite.

url
string
required

The page URL this favorite points to.

saved_view_id
string | null

The saved view to link this favorite to.

dashboard_id
string | null

The dashboard to link this favorite to.

folder_id
string | null

The folder to place this favorite in.

Response

Successful Response

A user's favorite — a bookmarked page in SELECT.

id
string
required
read-only

The unique identifier of the favorite.

etag
string
required
read-only

Opaque strong ETag for this favorite. Matches the ETag response header, and changes whenever any field on the favorite changes.

name
string
required

Display name for the favorite.

icon
string
required

Icon identifier for the favorite.

url
string
required

The page URL this favorite points to.

create_time
string
required
read-only

When the favorite was created.

update_time
string
required
read-only

When the favorite was last changed.

order
string | null

LexoRank order for top-level favorites. Null when inside a folder.

folder_id
string | null

The folder this favorite belongs to. Null for top-level favorites.

folder_order
string | null

LexoRank order within the folder. Null for top-level favorites.

saved_view_id
string | null

The saved view this favorite references, if any.

dashboard_id
string | null

The dashboard this favorite references, if any.