Skip to main content
PATCH
/
data
/
projects
/
{projectId}
/
queries
/
folders
/
{folderId}
/
name
Rename Query Folder
curl --request PATCH \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/folders/{folderId}/name \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Archived Reports"
}
'
{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Archived Reports",
  "path": "/Archived Reports",
  "parentId": null,
  "createdAt": "2025-01-15T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Use the Authorization header with the value 'Bearer ' to authenticate. Partner API Keys have full access; Project API Keys are limited to their project scope. Learn more: https://docs.peaka.com/api-reference/authentication

Path Parameters

​
projectId
string
required

ID of the Project

​
folderId
string
required

ID of the Query Folder

Body

application/json

Rename request

Request body for renaming a query folder

​
name
string
required

New name for the folder

Example:

"Archived Reports"

Response

Folder renamed successfully

Represents a query folder

​
id
string

Unique identifier of the folder (UUID)

Example:

"550e8400-e29b-41d4-a716-446655440000"

​
name
string

Display name of the folder

Example:

"Monthly Reports"

​
path
string

Full path of the folder in the hierarchy

Example:

"/reports/monthly"

​
parentId
string

ID of the parent folder, null if root-level

Example:

"550e8400-e29b-41d4-a716-446655440001"

​
createdAt
string

Timestamp when the folder was created (ISO 8601)

Example:

"2025-01-15T10:30:00Z"