Delete folder

Overview

This DELETE API allows user to delete one or more folders. The user must have proper permissions on each folder and its sub-folders to ensure successful deletion.

Permissions

  • 'Delete Folder' permission on each folder is required.

Preconditions

  • Folder should not be used as only topic in any portal.
SecurityoAuthUser
Request
path Parameters
ID
required
string

One folderID or Comma separated folder IDs

Example: one 201500000002039 or list 201500000002039,30029,452526
query Parameters
deleteIfUsedInPortal
string

Single value is allowed i.e "yes", it means the user is making an explicit request to delete specified folders even if some of their linked topics are used in a portal(s). If this parameter is absent and any of the topics linked to folders specified in the URI are used in a portal(s), the server will return '412 - Precondition Failed'.

Example: deleteIfUsedInPortal=yes
deleteUnreferencedArticles
string

Single value is allowed i.e "yes".To be passed if to execute new delete folder logic asynchronously.

Example: deleteUnreferencedArticles=yes
header Parameters
Accept-Language
required
string
Default: en-US

Language locale accepted by client (used for locale specific fields in resource representation and in error responses).

Enum: "en-US" "es-ES" "fr-FR" "it-IT" "de-DE" "nl-NL" "pt-BR" "pt-PT" "da-DK" "ru-RU" "fr-CA" "zh-CN" "ja-JP" "ko-KR" "sv-SE"
Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

405

Method not allowed

406

Not acceptable

412

Preconditions failed

500

Internal server error

delete/folders/{ID}
Request samples
Response samples
application/json
Required query parameter is missing


{
  • "code": "400-112",
  • "developerMessage": "Required query parameter(s) is missing. The following parameters are required: <param name>"
}