PATCH/spaces/api/v1/spaces/{spaceID}/pages/{pageID}.json

Update an existing page

Path Params

Name
spaceID
Type
integer
required
Description
Name
pageID
Type
integer
required
Description

Body Params

Name
page
Type
object
Description
PageUpdate is used to update a page.

Responses

Code
200
Type
object
Schema
Description
200 OK
Code
400
Type
object
Schema
Description
400 Bad Request
Code
404
Type
object
Schema
Description
404 Not Found
Code
500
Type
object
Schema
Description
500 Internal Server Error

Examples

200 OK

Page

{
  "page": {
    "LinkedInstallation": {
      "installation": {
        "id": 0,
        "meta": {},
        "type": "string"
      }
    },
    "banner": {
      "url": "string",
      "x": 0,
      "y": 0
    },
    "breadcrumb": {
      "trash": [
        {
          "childPages": [
            {
              "id": 0,
              "slug": "string",
              "title": "string",
              "updatedAt": "2024-12-19T16:02:34.102Z"
            }
          ],
          "id": 0,
          "slug": "string",
          "title": "string",
          "updatedAt": "2024-12-19T16:02:34.102Z"
        }
      ]
    },
    "changeMessage": "string",
    "content": "string",
    "contentRevision": 0,
    "createdAt": "2024-12-19T16:02:34.102Z",
    "createdBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "deletedAt": "2024-12-19T16:02:34.102Z",
    "deletedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "draftVersion": 0,
    "id": 0,
    "isFullWidth": true,
    "isHomePage": true,
    "isPrivate": true,
    "isPublished": true,
    "isRequiredReading": true,
    "meta": {
      "timeToRead": 0,
      "wordCount": 0
    },
    "order": 0,
    "parentId": 0,
    "publicShare": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "reactions": {
      "counts": {},
      "userReactionId": 0
    },
    "readerInlineCommentsEnabled": true,
    "slug": "string",
    "space": {
      "id": 0,
      "meta": {},
      "type": "string"
    },
    "state": "string",
    "summary": "string",
    "tags": [
      {
        "tag": {
          "color": "string",
          "createdAt": "2024-12-19T16:02:34.102Z",
          "createdBy": {
            "id": 0,
            "meta": {},
            "type": "string"
          },
          "deletedAt": "2024-12-19T16:02:34.102Z",
          "deletedBy": {
            "id": 0,
            "meta": {},
            "type": "string"
          },
          "id": 0,
          "name": "string",
          "pageCount": 0,
          "updatedAt": "2024-12-19T16:02:34.102Z",
          "updatedBy": {
            "id": 0,
            "meta": {},
            "type": "string"
          }
        }
      }
    ],
    "title": "string",
    "updatedAt": "2024-12-19T16:02:34.102Z",
    "updatedBy": {
      "id": 0,
      "meta": {},
      "type": "string"
    }
  }
}

Download Swagger