Skip to main content
POST
Reorder a favorite folder

Authorizations

Authorization
string
header
required

Organization API key (sl_…).

Headers

If-Match
string | null

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

x-tenant-id
string
required

The organization ID the request is scoped to.

Path Parameters

folder_id
string
required

Body

application/json

Request body for repositioning a favorite folder among the top-level items.

Folders are always top-level, so position is given relative to up to one sibling on each side, which may itself be a favorite or another folder.

before
ReorderNeighbor · object | null

The sibling that will come immediately before the folder.

after
ReorderNeighbor · object | null

The sibling that will come immediately after the folder.

Response

Successful Response

A folder that groups favorites.

id
string
required
read-only

The unique identifier of the folder.

etag
string
required
read-only

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

name
string
required

Display name for the folder.

order
string
required
read-only

LexoRank order among top-level items.

create_time
string
required
read-only

When the folder was created.

update_time
string
required
read-only

When the folder was last changed.