Skip to main content
PUT
/
data
/
projects
/
{projectId}
/
queries
/
folders
/
{folderId}
Add/Remove Query In/From Folder
curl --request PUT \
  --url https://partner.peaka.studio/api/v1/data/projects/{projectId}/queries/folders/{folderId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "queryIdsAdded": [
    "<string>"
  ],
  "queryIdsRemoved": [
    "<string>"
  ]
}
'
{
  "id": "<string>",
  "name": "<string>",
  "createdAt": 123,
  "modifiedAt": 123,
  "children": "<array>",
  "queryIds": [
    "<string>"
  ]
}

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
​
folderId
string
required

Body

application/json

Request body for updating a query folder (adding/removing query IDs).

Both lists are initialised to empty {@link ArrayList ArrayList}s so the serialised JSON always contains "queryIdsAdded": [...] and "queryIdsRemoved": [...]. The search service requires both fields to be present (non-null) and rejects null with a validation error.

​
queryIdsAdded
string[]
​
queryIdsRemoved
string[]

Response

200 - application/json

Folder Created

​
id
string
​
name
string
​
createdAt
integer<int64>
​
modifiedAt
integer<int64>
​
children
array
​
queryIds
string[]