Update a Shared Folder
API Explorer: /folders/{folderId}
To update a shared folder, you need to know the folderId
. The sample code updates a shared folder with an ID of 5b96c41fad67294528f03df8
to make the files in the shared folder deletable. Use the actual ID value for the shared folder to update it.
folderId
of the shared folder to update, use List Shared Folders to return a list of your created shared folders.Update a Shared Folder
curl 'https://a.blazemeter.com/api/v4/folders/5b96c41fad67294528f03df8' \
-X PATCH \
-H 'Content-Type: application/json' \
--user 'api_key_id:api_key_secret' \
-d '{"folderId":"5b7dc9c6c7dc9739167b23c8","data":{"deletable":true}}'
Update a Shared Folder Request Attributes
Attributes
-
folderId
booleanrequired
The
folderId
of the folder being updated. Must match thefolderId
from the URL -
data
objectrequired
The data details to be updated in the shared folder
Show/Hide Child Attributes-
deletable
booleanrequired
Denotes if the files within the shared folder are deletable or not.
true
- Files can be deletedfalse
- Files cannot be deleted
-
Update a Shared FolderUpdate a Shared Folder PATCH Body (JSON)
{
"folderId": "5b7dc9c6c7dc9739167b23c8",
"data": {
"deletable": true
}
}
Update a Shared Folder Response Attributes
To see a breakdown of the attributes, please see The Folder Object section.
Response200 OK
{
"api_version": 4,
"error": null,
"result": {
"id": "5b7dc9c6c7dc9739167b23c8",
"name": "ApiTest",
"deletable": true,
"created": 1534970310
},
"request_id": "5ef2700d7c817"
}