Delete a folder

Preview

deletehttps://api.expiryedge.com/v2/folders/{id}

editor or admin60/min

Request

curl -X DELETE 'https://api.expiryedge.com/v2/folders/fol_123?force=false' \
  -H "Authorization: Bearer $EXPIRYEDGE_API_KEY"

Response

No response body.

A folder with subfolders or active expiries is 409 FOLDER_NOT_EMPTY (details: children_count, expiries_count) unless force=true, which also deletes its subfolders and moves its expiries out of the folder (expiries are not deleted).

Path parameters

idstringrequired

Query parameters

forcestring
AllowedtruefalseDefault false

Returns

204

Deleted.

Errors

`400`	Invalid parameters or body (`VALIDATION_FAILED`; `details` names the fields).
`401`	Missing, invalid or expired token (`UNAUTHORIZED`).
`403`	Your role can't do this, or your account has no organization (`FORBIDDEN`).
`404`	No such record in your organization (records in other organizations are also 404).
`405`	Wrong HTTP method for this path; the `Allow` header lists the valid ones.
`409`	State or uniqueness conflict: `EMAIL_EXISTS` (contacts), `GROUP_EXISTS` (contact groups), `CONFLICT` (folder name taken), `FOLDER_NOT_EMPTY`, `CLIENT_HAS_PROJECTS`, `TOO_MANY_ATTACHMENTS`, `INVALID_STATE` (collection request cancel/resend), or `IDEMPOTENCY_IN_PROGRESS` (same Idempotency-Key still running; see Retry-After).
`429`	Too many requests for this endpoint from your IP. Wait `Retry-After` seconds.