Data -- Query Folders

Rename Query Folder

Renames a query folder. The folder's path segments are updated to reflect the new name.

patch/data/projects/{projectId}/queries/folders/{folderId}/name

Request

  • Base URL: https://partner.peaka.studio/api/v1
  • URL: https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/folders/{folderId}/name
  • Auth: HTTP bearer

Path parameters

projectIdstring required

ID of the Project

folderIdstring required

ID of the Query Folder

Request body

namestring required

New name for the folder

Example request

{
  "name": "Archived Reports"
}

Response

Folder renamed successfully

idstring

Unique identifier of the folder (UUID)

namestring

Display name of the folder

pathstring

Full path of the folder in the hierarchy

parentIdstring

ID of the parent folder, null if root-level

createdAtstring

Timestamp when the folder was created (ISO 8601)

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Monthly Reports",
  "path": "/reports/monthly",
  "parentId": "550e8400-e29b-41d4-a716-446655440001",
  "createdAt": "2025-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.