Pages
Update a page property
Modifies properties of a specified page, such as its title, position, and content. Only provided fields will be updated.
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": []
},
"archived": true,
"hide_table_of_contents": true,
"hide_subpages": true
}
'import requests
url = "https://api.superthread.com/v1/{team_id}/pages/{page_id}"
payload = {
"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": []
},
"archived": True,
"hide_table_of_contents": True,
"hide_subpages": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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: []},
archived: true,
hide_table_of_contents: true,
hide_subpages: true
})
};
fetch('https://api.superthread.com/v1/{team_id}/pages/{page_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.superthread.com/v1/{team_id}/pages/{page_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
]
],
'archived' => true,
'hide_table_of_contents' => true,
'hide_subpages' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.superthread.com/v1/{team_id}/pages/{page_id}"
payload := strings.NewReader("{\n \"title\": \"Team Page\",\n \"font\": \"<string>\",\n \"project_id\": \"3\",\n \"is_public\": false,\n \"parent_page_id\": \"44\",\n \"position\": 3,\n \"public_settings\": {\n \"url\": \"https://pages.superthread.com/t/team/p/1\",\n \"robots\": []\n },\n \"archived\": true,\n \"hide_table_of_contents\": true,\n \"hide_subpages\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.superthread.com/v1/{team_id}/pages/{page_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Team Page\",\n \"font\": \"<string>\",\n \"project_id\": \"3\",\n \"is_public\": false,\n \"parent_page_id\": \"44\",\n \"position\": 3,\n \"public_settings\": {\n \"url\": \"https://pages.superthread.com/t/team/p/1\",\n \"robots\": []\n },\n \"archived\": true,\n \"hide_table_of_contents\": true,\n \"hide_subpages\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superthread.com/v1/{team_id}/pages/{page_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Team Page\",\n \"font\": \"<string>\",\n \"project_id\": \"3\",\n \"is_public\": false,\n \"parent_page_id\": \"44\",\n \"position\": 3,\n \"public_settings\": {\n \"url\": \"https://pages.superthread.com/t/team/p/1\",\n \"robots\": []\n },\n \"archived\": true,\n \"hide_table_of_contents\": true,\n \"hide_subpages\": true\n}"
response = http.request(request)
puts response.read_body{
"page": {
"id": "43",
"alias_id": "93738022-c193-494e-95a4-fc3e4346b5e1",
"title": "Team Page",
"icon": {
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"content": "<string>",
"schema": 1,
"collaboration": {
"token": "<string>"
},
"project_id": "1",
"standalone": false,
"cover_image": {
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup",
"positionY": 123
},
"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,
"on_behalf_of": "<string>"
}
},
"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,
"on_behalf_of": "<string>"
}
},
"team_id": "teu-dsu0j19",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016
}
],
"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": []
},
"total_comments": 3,
"is_watching": true,
"is_bookmarked": true,
"hide_table_of_contents": true,
"hide_subpages": true
}
}{
"error": {
"id": "err5f744ab",
"code": 403,
"sec": "SEC:000-00014",
"message": "You do not have access to this resource",
"date": 1608742037016
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Team ID is an alphanumerical string that identifies a Team. This is externally referred to as a "Workspace".
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.
Example:
"Team Page"
Example:
"3"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Example:
false
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"
a position where the page should be placed in relation to its siblings
Example:
3
Show child attributes
Show child attributes
make this page archived or unarchived
Example:
true
whether to show a table of contents on page
Example:
true
whether to show subpages section on page
Example:
true
Response
updated page response
Show child attributes
Show child attributes
Previous
Replace a page's contentOverwrites the content of a specified page within a workspace (`team_id`).
Accepts either raw HTML or structured content which is proxied to the collaboration server.
Next
⌘I
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": []
},
"archived": true,
"hide_table_of_contents": true,
"hide_subpages": true
}
'import requests
url = "https://api.superthread.com/v1/{team_id}/pages/{page_id}"
payload = {
"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": []
},
"archived": True,
"hide_table_of_contents": True,
"hide_subpages": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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: []},
archived: true,
hide_table_of_contents: true,
hide_subpages: true
})
};
fetch('https://api.superthread.com/v1/{team_id}/pages/{page_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.superthread.com/v1/{team_id}/pages/{page_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
]
],
'archived' => true,
'hide_table_of_contents' => true,
'hide_subpages' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.superthread.com/v1/{team_id}/pages/{page_id}"
payload := strings.NewReader("{\n \"title\": \"Team Page\",\n \"font\": \"<string>\",\n \"project_id\": \"3\",\n \"is_public\": false,\n \"parent_page_id\": \"44\",\n \"position\": 3,\n \"public_settings\": {\n \"url\": \"https://pages.superthread.com/t/team/p/1\",\n \"robots\": []\n },\n \"archived\": true,\n \"hide_table_of_contents\": true,\n \"hide_subpages\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.superthread.com/v1/{team_id}/pages/{page_id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Team Page\",\n \"font\": \"<string>\",\n \"project_id\": \"3\",\n \"is_public\": false,\n \"parent_page_id\": \"44\",\n \"position\": 3,\n \"public_settings\": {\n \"url\": \"https://pages.superthread.com/t/team/p/1\",\n \"robots\": []\n },\n \"archived\": true,\n \"hide_table_of_contents\": true,\n \"hide_subpages\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.superthread.com/v1/{team_id}/pages/{page_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Team Page\",\n \"font\": \"<string>\",\n \"project_id\": \"3\",\n \"is_public\": false,\n \"parent_page_id\": \"44\",\n \"position\": 3,\n \"public_settings\": {\n \"url\": \"https://pages.superthread.com/t/team/p/1\",\n \"robots\": []\n },\n \"archived\": true,\n \"hide_table_of_contents\": true,\n \"hide_subpages\": true\n}"
response = http.request(request)
puts response.read_body{
"page": {
"id": "43",
"alias_id": "93738022-c193-494e-95a4-fc3e4346b5e1",
"title": "Team Page",
"icon": {
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup"
},
"content": "<string>",
"schema": 1,
"collaboration": {
"token": "<string>"
},
"project_id": "1",
"standalone": false,
"cover_image": {
"src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
"id": "<string>",
"blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
"color": "black",
"emoji": "thumbsup",
"positionY": 123
},
"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,
"on_behalf_of": "<string>"
}
},
"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,
"on_behalf_of": "<string>"
}
},
"team_id": "teu-dsu0j19",
"time_created": 1608742037016,
"time_updated": 1608742037016,
"members": [
{
"user_id": "u-dsu0j19",
"assigned_date": 1608742037016
}
],
"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": []
},
"total_comments": 3,
"is_watching": true,
"is_bookmarked": true,
"hide_table_of_contents": true,
"hide_subpages": true
}
}{
"error": {
"id": "err5f744ab",
"code": 403,
"sec": "SEC:000-00014",
"message": "You do not have access to this resource",
"date": 1608742037016
}
}