Sign in
latestOpenAPI 3.1.02026-08-171503582.2 MB

6199a9464227

Pages

Update a page

Updates a page. PUT semantics: all fields must be provided. Returns the updated page.

put/pages/{pageId}

Path parameters

pageIdstring required

The ID of the Page

Request body

namestring required

Display name.

descriptionstring

Optional free-form description of the page.

folderIdstring required

The ID of the Folder.

shareLevel'None' | 'View' required

Controls who can view this page. None — only organization members can view this page. View — anyone with the link can view this page.

referenceIdstring

Version prefix used when version control is enabled on this page. Combined with the version number to form the full version identifier.

Response

Example response

{
  "data": {
    "createdBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "updatedBy": {
      "id": "naAJxoDIuwdgNsQHGRRGqA",
      "email": "jane.doe@example.com",
      "username": "Jane Doe"
    },
    "links": [
      {
        "href": "https://api.process.st/api/v1.1/resource/XXX"
      }
    ]
  },
  "links": [
    {
      "href": "https://api.process.st/api/v1.1/resource/XXX"
    }
  ]
}