Investor Custom Folders

Delete an investor custom folder

DELETE/investor-custom-folders/{id}
documents:writedelete_investor_custom_folderDestructiveIdempotent

Removes the setting and returns 204. The folders already made under users' Other folders stay; delete them with DELETE /folders/{id}. Needs the permission to view all documents in all deals, or super admin, on the token's user; any other token, service tokens included, gets 403 missing_permission. An unknown id returns 404. It has no dry run: dry_run returns 422. It emits investor_custom_folder.deleted after commit and sends no email. POST /investor-custom-folders undoes it by adding the setting again, which makes the folders for every user.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Responses

204

The setting was removed.

401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X DELETE https://your-org-domain/kong/core/api/v2/investor-custom-folders/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"