Delete a folder

posthttps://api.expiryedge.com/v1/deleteFolder

editor or admin60/minJede Methode

Anfrage

curl -X POST 'https://api.expiryedge.com/v1/deleteFolder?id=fld_8Tz4&force=false' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "folderId": "fld_8Tz4",
  "force": true
}'

Antwort

{
  "success": true,
  "message": "Folder deleted successfully",
  "deleted_subfolders": 0
}

Soft-deletes the folder (folderId in the body, or id query parameter). A folder with subfolders or expiries returns 400 unless force is true; with force, its expiries are un-filed and subfolders deleted.

Query-Parameter

idstring
Folder id (alternative to body folderId).
forceboolean
Delete even when not empty.
Standard false

Body-Parameter

application/json

folderIdstring
forceboolean or string

Rückgabe

200

Folder deleted.

successbooleanerforderlich
messagestringerforderlich
deleted_subfoldersintegererforderlich

Fehler

`400`	Missing folder id, or the folder is not empty and `force` was not set.
`401`	Missing, expired or invalid bearer token.
`403`	Authenticated, but your role or organization does not allow this action.
`404`	The record does not exist or is not in your organization.
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.
`500`	Unexpected server error. Retry later; quote `requestId` to support.