Knowledge Base

Delete a folder and all its contents.

Required permission: WRITER or higher. A READER gets 403; a caller with no role on the knowledge base gets 404.

Cascade delete:

All subfolders and records within are deleted for good, unless "Move Deleted Records to the Trash" (Labs flag ENABLE_SOFT_DELETE) is on: then they all go to the trash and can be brought back with POST /knowledgeBase/record/{folderId}/restore. The response is the same in both cases. Known gap: while in the trash, the folder is still listed in folders by GET /knowledgeBase/{kbId}, although its records answer 404.

Request: kbId and folderId are only checked to be non-empty; any query string or body is ignored.

delete/knowledgeBase/{kbId}/folder/{folderId}

Request

  • Base URL
    https://app.pipeshub.com/api/v1
  • URL
    https://app.pipeshub.com/api/v1/knowledgeBase/{kbId}/folder/{folderId}
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: /api/v1/oauth2/authorize
      Client credentials
      Token URL: /api/v1/oauth2/token scopes: kb:delete

Path parameters

kbIdstring required
folderIdstring required

Response

Folder deleted successfully

successboolean required
messagestring required

Example response

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

Changes

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status