Delete a Folder

Soft-delete a folder.

cascade=false (default): blocks if the folder has any non-archived child folder or file (HTTP 409). cascade=true: soft-deletes the folder, every descendant folder, and every file whose folder_id is in the subtree.

DELETE /folders/{folder_id}

Delete Folder

cURL

curl --request DELETE \
  --url https://api.example.com/folders/{folder_id} \
  --header 'Authorization: Bearer <token>'

200

{}

Soft-deletes a folder (sets archived_at). By default, refuses with 409 if the folder has any non-archived child folder or file. With cascade=true, it archives the folder, every descendant folder, and every file whose folder_id falls anywhere in that subtree — all in one call.

Auth

Requires a CRM manage scope and an active organization on the token. Any *:manage scope qualifies — in practice contacts:manage, deals:manage, companies:manage, or activities:manage.

Response

Field	Type	Description
deleted	boolean	Always true.
folder_count	integer	Number of folders archived — the target folder plus its descendants (1 if cascade wasn’t needed).
file_count	integer	Number of files archived as part of the cascade (0 if none, or if cascade was false).

Errors

Status	Cause
404 Not Found	folder_id doesn’t exist among non-archived folders in this org.
409 Conflict	The folder has at least one descendant folder (at any depth), or a non-archived file anywhere in its subtree, and cascade wasn’t true.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

folder_id · string · required

UUID of the folder to soft-delete.

Query Parameters

cascade · boolean · default: false

When true, also archives every descendant folder and every file in the subtree; when false (default), fails with 409 if the folder has any non-archived child folder or file.

Response

200

application/json

Successful Response

The response is of type Response Delete Folder Folders Folder Id Delete · object.