Skip to main content
PATCH
/
{team_id}
/
pages
/
{page_id}
Update a page
curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/pages/{page_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Team Page",
  "font": "<string>",
  "project_id": "3",
  "is_public": false,
  "parent_page_id": "44",
  "position": 3,
  "public_settings": {
    "url": "https://pages.superthread.com/t/team/p/1",
    "robots": [
      "all"
    ]
  },
  "archived": true,
  "hide_table_of_contents": true,
  "hide_subpages": true
}
'
{
  "page": {
    "id": "43",
    "alias_id": "93738022-c193-494e-95a4-fc3e4346b5e1",
    "title": "Team Page",
    "font": "sans",
    "content": "<string>",
    "schema": 1,
    "collaboration": {
      "token": "<string>"
    },
    "project_id": "1",
    "user_id": "u-dsu0j19",
    "user_id_updated": "u-dsu0j19",
    "user": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "somebody@example.com",
        "email_verified": false
      }
    },
    "user_updated": {
      "user_id": "uDsu0j19",
      "type": "user",
      "source": {
        "type": "oauth",
        "client_id": "oczapier",
        "import_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "agent_id": "bf1b9f76-3f95-42fc-bd7f-050b2f5f4197",
        "email_addr": "somebody@example.com",
        "email_verified": false
      }
    },
    "team_id": "teu-dsu0j19",
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016,
        "role": "admin"
      }
    ],
    "bookmarked": false,
    "archived": {
      "user_id": "uDsu0j19",
      "time_archived": 1608742037016,
      "parent_page_id": "<string>"
    },
    "is_public": false,
    "public_settings": {
      "url": "https://pages.superthread.com/t/team/p/1",
      "robots": [
        "all"
      ]
    },
    "total_comments": 3,
    "is_watching": true,
    "is_bookmarked": true,
    "hide_table_of_contents": true,
    "hide_subpages": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
team_id
string
required

Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".

​
page_id
string
required

Page ID is a numerical string that identifies a Page.

Body

application/json

Page fields that need to be updated. All omitted fields are left unmodified.

​
title
string | null
Example:

"Team Page"

​
font
string | null
​
project_id
string | null
Example:

"3"

​
cover_image
object
​
icon
object
​
is_public
boolean | null
Example:

false

​
parent_page_id
string | null

Parent page ID this page should be placed under. Send an empty string to place the page at the root of the project

Example:

"44"

​
position
integer | null

a position where the page should be placed in relation to its siblings

Example:

3

​
public_settings
object
​
archived
boolean | null

make this page archived or unarchived

Example:

true

​
hide_table_of_contents
boolean | null

whether to show a table of contents on page

Example:

true

​
hide_subpages
boolean | null

whether to show subpages section on page

Example:

true

Response

updated page response

​
page
object