Skip to main content
DELETE
/
api
/
v1
/
external
/
companies
/
{companyId}
/
folders
/
{folderId}
Delete Folder
curl --request DELETE \
  --url https://app.aiinsurance.io/api/v1/external/companies/{companyId}/folders/{folderId} \
  --header 'Authorization: <api-key>'
{
  "id": "550e8400-e29b-41d4-a716-446655440001",
  "deleted": true,
  "deletedFolders": 2,
  "deletedFiles": 3
}

Authorizations

​
Authorization
string
header
required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

​
companyId
string<uuid>
required

Company identifier

​
folderId
string<uuid>
required

Folder identifier

Response

Folder deleted successfully

​
id
string<uuid>

Id of the deleted folder

​
deleted
boolean

Always true on success

​
deletedFolders
integer

Live folders soft-deleted (the folder itself plus descendants)

​
deletedFiles
integer

Live files soft-deleted because their placement was in the subtree