Sirportly

Toggle Menu

Edit existing page

This method allows you to create a new page within your knowledge base.

URL

/api/v2/knowledge/edit_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 edit (optional, you will edit the homepage if none specified)
  • title - the title for the page (optional)
  • content - the raw content for the page (optional)
  • permalink - the permalink for the page (optional). This must only include letters, numbers and hyphens.

Returned Data

The page properties will be returned with a 200 OK status if the page is saved successfully. If the page is not saved successfully, you will receive an array of errors with a 422 Unprocessable Entity status.

Example JSON

{
  "id": 12,
  "title": "Another Section",
  "permalink": "another-section",
  "full_permalink": "another-section",
  "position": 3,
  "content": "Some new content",
  "user": {
    "id": 1,
    "username": "adam",
    "first_name": "Adam",
    "last_name": "Cooke",
    "email_address": "adam@atechmedia.com",
    "time_zone": "London",
    "created_at": "2012-01-24T14:29:22+00:00"
  },
  "created_at": "2012-01-26T11:23:49+00:00",
  "updated_at": "2012-01-26T11:32:54+00:00"
}