Skip to main content
cURL

Authorizations

Authorization
string
header
required

An API key: Authorization: Bearer alura_sk_....

Headers

Idempotency-Key
string

Makes a retry safe: the same key with the same request within 24 hours returns the first result (with Idempotent-Replayed: true) instead of writing again. The same key with a different request is a 409 conflict; while the first request still runs, 409 idempotency_processing.

Required string length: 1 - 255

Path Parameters

id
string
required

The folder ID (fld_...).

Required string length: 1 - 64
Example:

"fld_0000000000000000000000000A"

Query Parameters

lists
enum<string>

For a folder that holds lists: move_to_root keeps them outside any folder, delete deletes them with it. Without it such a folder is not deleted (409).

Available options:
move_to_root,
delete

Response

OK

object
string
required
Allowed value: "research.saved_folder"
id
string
required
deleted
boolean
required
lists_moved_to_root
integer
required

Lists taken out of the folder (lists=move_to_root).

Required range: x >= 0
lists_deleted
integer
required

Lists deleted with the folder (lists=delete).

Required range: x >= 0