Skip to main content
POST
Reorder a favorite

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

If-Match
string | null

The favorite's current ETag, from a prior read. Required: the request is rejected if the favorite has changed since.

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

favorite_id
string
required

Body

application/json

Request body for repositioning a favorite.

Position is given relative to up to one sibling on each side, in the favorite's list after the move — its target folder if folder_id is set, the top level otherwise. Omit a side when the favorite is moving to an end of that list; omit both to make it that list's only item.

folder_id
string | null

The folder to move the favorite into. Null moves it to the top level.

before
ReorderNeighbor · object | null

The sibling that will come immediately before the favorite.

after
ReorderNeighbor · object | null

The sibling that will come immediately after the favorite.

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.