API referenceFolders

Delete a folder

posthttps://api.expiryedge.com/v1/deleteFolder
editor or admin60/minAny method
Request
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
}'
Response
{
  "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 parameters

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

Body parameters

application/json
  • folderIdstring
  • forceboolean or string

Returns

200
Folder deleted.
  • successbooleanrequired
  • messagestringrequired
  • deleted_subfoldersintegerrequired

Errors

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.