Sirportly

Toggle Menu

Deleting a page

This method allows you to remove a page (and it's children) from a knowledge base.

URL

/api/v2/knowledge/delete_page

Access

Only account tokens are permitted to access this method.

Supported Parameters

  • kb - the ID of the knowledge base you wish to add a page to (required)
  • path - the path to the page you wish to delete (required)

Returned Data

If successful, you will receive a 200 OK status with a hash containing the status. If the deletion was not completed, you will receive a 409 Conflict with a hash containing the status. This is most likely to occur if you attempt to remove the homepage (by not passing a path parameter). The homepage cannot be removed.

Example JSON

{
  "status": "ok"
}