Delete knowledge base

DELETE

/knowledge/{id}

curl --request DELETE \
  --url https://api.amitysolutions.com/api/v1/knowledge/1 \
  --header 'x-api-key: <x-api-key>'

• ASAP API Endpoint

Authorizations

• apiKey

Parameters

Path Parameters

id

required

number

Knowledge Base ID

Responses

204

Processed Successfully.

401

Unauthorized Error. ASAP will return this error when there is either no api key, invalid api key or the client`s IP address is not whitelisted.

Media typeapplication/json

object

name

string

code

number

status

number

message

string

errors

Array<object>

object

Example

{
  "name": "UnauthorizedException",
  "code": 401001,
  "status": 401,
  "message": "Unauthorized",
  "errors": []
}

404

Knowledge base not found

Media typeapplication/json

object

name

Name of the error

string

code

ASAP platform specific error code

number

status

HTTP status code

number

message

Error message details

string

errors

Array<object>

object

Example

{
  "name": "NotFoundException",
  "code": 404001,
  "status": 404,
  "message": "Knowledge base with specified ID not found.",
  "errors": []
}

422

Validation Error

Media typeapplication/json

object

name

Name of the error

string

code

ASAP platform specific error code

number

status

HTTP status code

number

message

Error message details

string

errors

Array<object>

object

type

required

Type of error

string

field

required

Name of the field having the error

string

value

Input value

string

message

required

Error message

string

Example

{
  "name": "UnprocessableEntityException",
  "code": 422001,
  "status": 422,
  "message": "request payload validation failed",
  "errors": [
    {
      "type": "isNotEmpty",
      "field": "name",
      "message": "name must not be empty"
    },
    {
      "type": "min",
      "field": "limit",
      "value": -1,
      "message": "limit must not be less than 1"
    }
  ]
}

429

Too Many Requests

Media typeapplication/json

object

name

Name of the error

string

code

ASAP platform specific error code

number

status

HTTP status code

number

message

Error message details

string

errors

Array<object>

object

Example

{
  "name": "RateLimitExceededException",
  "code": 429001,
  "status": 429,
  "message": "Rate limit exceeded",
  "errors": []
}