Documents Plugin

Delete a document category.

DELETE

http://localhost:3000/api/plugins/docs/categories/{id}

curl -X DELETE 'http://localhost:3000/api/plugins/docs/categories/string'

const response = await fetch('http://localhost:3000/api/plugins/docs/categories/string', {
  method: 'DELETE',
});

const data = await response.text();

import requests

response = requests.delete('http://localhost:3000/api/plugins/docs/categories/string')
print(response.text)

200

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "name": "string",
  "slug": "string",
  "color": "string",
  "icon": "string",
  "description": "string",
  "isSystem": true
}

Parameters

idstringrequiredpath

Response

200OKDocumentCategory

Category deleted successfully.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

slugstringrequired

colorstring

iconstring

descriptionstring

isSystembooleanrequired

409Conflict

System categories cannot be deleted.

Stack Overflow Website Demo