Skip to main content
PATCH
/
v1
/
folders
/
{shortId}
Update folder
curl --request PATCH \
  --url https://api.uselora.com/v1/folders/{shortId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "teamId": "<string>",
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "isSystem": true,
  "workspaceId": "<string>",
  "creatorId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://uselora.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
shortId
string
required

Folder short ID. 8-char Crockford-base32 handle (no i/l/o/u).

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$
Example:

"a1b2c3d4"

Body

application/json

Payload to update a folder

​
teamId
string | null

If accessLevel is "team", provide the Team ID here.

​
name
string

The folder name (3..190 chars). The slug is derived from this server-side.

Required string length: 3 - 190
Example:

"Marketing"

​
description
string | null

Optional description for the folder

​
accessLevel
enum<string>

Who can see this folder? "workspace" (everyone), "team", or "none" (invite-only). Omit to leave unchanged.

Available options:
workspace,
team,
none
Example:

"workspace"

Response

The updated folder.

A folder.

​
id
string
required

Stable 8-char Crockford-base32 handle (no i/l/o/u). Use this in URL paths and to address the folder via the API.

Pattern: ^[0-9abcdefghjkmnpqrstvwxyz]{8}$
Example:

"a1b2c3d4"

​
name
string
required
​
slug
string
required
​
description
string | null
required
​
accessLevel
enum<string>
required
Available options:
workspace,
team,
none
​
isSystem
boolean
required

True for built-in folders such as the workspace default. Folders you create are always false.

​
workspaceId
string
required

ID of the workspace the folder belongs to.

​
creatorId
string
required

ID of the user who created the folder.

​
createdAt
string
required

ISO 8601 creation timestamp.

​
updatedAt
string
required

ISO 8601 timestamp of the last update.