POST
/
v2
/
organizations
/
folders
/
delete
Delete Folder
curl --request POST \
  --url https://api.velt.dev/v2/organizations/folders/delete \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '{
  "data": {
    "organizationId": "<string>",
    "folderId": "<string>"
  }
}'
{
   "result": {
       "status": "success",
       "message": "Folder deletion initiated successfully.",
       "data": null
   }
}
Delete a folder and all its contents (documents and subfolders).
Prior to using this API, you must:
  • Enable advanced queries option in the console
  • Deploy v4 series of the Velt SDK.

​
Endpoint

POST https://api.velt.dev/v2/organizations/folders/delete

​
Headers

​
x-velt-api-key
string
required
Your API key.
​
x-velt-auth-token
string
required
Your Auth Token.

​
Body

​
data
object
required

​
Example Request

{
   "data": {
       "organizationId": "org10",
       "folderId": "folderId2"
   }
}

​
Response

​
Success Response

{
   "result": {
       "status": "success",
       "message": "Folder deletion initiated successfully.",
       "data": null
   }
}

​
Failure Response

{
   "error": {
       "code": "not-found",
       "message": "Folder not found."
   }
}

{
   "result": {
       "status": "success",
       "message": "Folder deletion initiated successfully.",
       "data": null
   }
}