ressource.socialbetadocumentation
API referenceFolders

Rename, describe, recolour or move a folder

Only the fields sent change. `parent_folder_id` moves the folder with its whole subtree — `null` to the root. Moving a folder into itself or one of its own subfolders, or past ten levels deep, is 400; a parent that is not the caller's is 404; a name a new sibling already has is 409.

PATCH
/api/v1/folders/{id}

Sends a real request with your token. Prefer a read-only token; it is kept in this browser's storage.

Only the fields sent change. parent_folder_id moves the folder with its whole subtree — null to the root. Moving a folder into itself or one of its own subfolders, or past ten levels deep, is 400; a parent that is not the caller's is 404; a name a new sibling already has is 409.

Authorization

headerAuthorizationBearer <token>

A personal access token (rsk_…) or a Supabase access token.

Path Parameters

id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Request Body

application/json
  1. body
name?string
Length1 <= length <= 255
parent_folder_id?|null
description?|null
color?|null
icon?|null
is_private?boolean
sort_order?integer
Range0 <= value <= 1000000

Response Body

The updated folder

application/json
  1. response
id*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid
name*string
description*string|null
parent_folder_id*|null
color*string|null
icon*string|null
is_private*boolean|null
sort_order*number|null
level*number|null
path*string|null
created_at*string|null
updated_at*string|null
child_folder_count*number
bookmark_count*number
curl -X PATCH 'https://www.ressource.social/api/v1/folders/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "description": "string",  "parent_folder_id": "26caaf35-00f1-4c8f-a2ac-cb04b9b9a6ec",  "color": "string",  "icon": "string",  "is_private": true,  "sort_order": 0,  "level": 0,  "path": "string",  "created_at": "string",  "updated_at": "string",  "child_folder_count": 0,  "bookmark_count": 0}

File sources into a folder, or out of every folder POST

Up to 500 of the caller's own sources per call, all or nothing: if the folder is not the caller's, or any id is not one of the caller's sources, nothing moves and the answer is 404 — with the unknown ids in `details.missing` for the latter. `moved` lists the sources whose folder changed; `unchanged` counts the ones already there.

Attach files to one of the caller's sources POST

Multipart: `files` (repeat the field, up to 10). Each file succeeds or fails on its own: `attachments` lists the ones attached, `errors` the others with why. 201 when at least one was attached, 200 when none were. Someone else's source is 404. Accepted types: image/jpeg, image/jpg, image/png, image/gif, image/webp, image/svg+xml, image/avif, image/bmp, image/tiff, image/heic, image/heif, image/x-icon, image/vnd.microsoft.icon, application/pdf, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plain, text/markdown, application/zip, application/x-zip-compressed. At most 50 MB.