Update a page

PATCH

{team_id}

pages

{page_id}

Update a page

curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/pages/{page_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Team Page",
  "font": "<string>",
  "project_id": "3",
  "cover_image": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "id": "<string>",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup",
    "positionY": 123,
    "object_fit": "contain"
  },
  "icon": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "id": "<string>",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup"
  },
  "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",
    "icon": {
      "type": "image",
      "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",
    "cover_image": {
      "type": "image",
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup",
      "positionY": 123,
      "object_fit": "contain"
    },
    "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": "[email protected]",
        "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": "[email protected]",
        "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
  }
}

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

Show child attributes

cover_image.type

enum<string>

required

Available options:

image,

icon,

emoji

cover_image.src

string

required

Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name

Example:

"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="

cover_image.id

string

Unique identifier for the image (optional).

cover_image.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

cover_image.color

string

Example:

"black"

cover_image.emoji

string

Emoji string ID

Example:

"thumbsup"

cover_image.positionY

number

cover_image.object_fit

enum<string> | null

Available options:

contain,

cover

icon

object

Show child attributes

icon.type

enum<string>

required

Available options:

image,

icon,

emoji

icon.src

string

required

Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name

Example:

"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="

icon.id

string

Unique identifier for the image (optional).

icon.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

icon.color

string

Example:

"black"

icon.emoji

string

Emoji string ID

Example:

"thumbsup"

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

Show child attributes

public_settings.url

string

Example:

"https://pages.superthread.com/t/team/p/1"

public_settings.robots

enum<string>[]

Available options:

all,

index,

follow,

none,

noindex,

nofollow,

noimageindex,

nosnippet,

noarchive,

nocache,

notranslate

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

Show child attributes

page.id

string

Example:

"43"

page.alias_id

string

Example:

"93738022-c193-494e-95a4-fc3e4346b5e1"

page.title

string

Example:

"Team Page"

page.font

enum<string>

Available options:

sans,

serif,

mono

page.icon

object

Show child attributes

page.icon.type

enum<string>

required

Available options:

image,

icon,

emoji

page.icon.src

string

required

Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name

Example:

"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="

page.icon.id

string

Unique identifier for the image (optional).

page.icon.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

page.icon.color

string

Example:

"black"

page.icon.emoji

string

Emoji string ID

Example:

"thumbsup"

page.content

string

Maximum string length: 102400

page.schema

integer

Example:

1

page.collaboration

object

Show child attributes

page.collaboration.token

string

Security token used to start a collaboration session

page.project_id

string

Example:

"1"

page.cover_image

object

Show child attributes

page.cover_image.type

enum<string>

required

Available options:

image,

icon,

emoji

page.cover_image.src

string

required

Depending on the type this can be a URL, base64 image data, emoji unicode or an icon name

Example:

"data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg=="

page.cover_image.id

string

Unique identifier for the image (optional).

page.cover_image.blurhash

string

Example:

"LEHV6nWB2yk8pyoJadR*.7kCMdnj"

page.cover_image.color

string

Example:

"black"

page.cover_image.emoji

string

Emoji string ID

Example:

"thumbsup"

page.cover_image.positionY

number

page.cover_image.object_fit

enum<string> | null

Available options:

contain,

cover

page.user_id

string

Example:

"u-dsu0j19"

page.user_id_updated

string

Example:

"u-dsu0j19"

page.user

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

page.user.user_id

string

Example:

"uDsu0j19"

page.user.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

page.user.source

ActorSource · object

describes the source of an actor

Show child attributes

page.user.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

page.user.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

page.user.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

page.user.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

page.user.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

page.user.source.email_verified

boolean

whether the email sender was verified

Example:

false

page.user_updated

Actor · object

describes a user or robot that created or updated a resource

Show child attributes

page.user_updated.user_id

string

Example:

"uDsu0j19"

page.user_updated.type

enum<string>

default:user

Available options:

user,

robot,

system

Example:

"user"

page.user_updated.source

ActorSource · object

describes the source of an actor

Show child attributes

page.user_updated.source.type

enum<string>

Available options:

oauth,

import,

email,

agent

Example:

"oauth"

page.user_updated.source.client_id

string

client ID if the resource was created via oauth2 app

Example:

"oczapier"

page.user_updated.source.import_id

string

import ID if the resource was created by an import

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

page.user_updated.source.agent_id

string

agent ID if the resource was created by an agent

Example:

"bf1b9f76-3f95-42fc-bd7f-050b2f5f4197"

page.user_updated.source.email_addr

string

email address if the resource was created via an email

Example:

"[email protected]"

page.user_updated.source.email_verified

boolean

whether the email sender was verified

Example:

false

page.team_id

string

Example:

"teu-dsu0j19"

page.time_created

integer<int64>

unix timestamp in seconds

Example:

1608742037016

page.time_updated

integer<int64>

unix timestamp in seconds

Example:

1608742037016

page.members

object[]

Show child attributes

page.members.user_id

string

Example:

"u-dsu0j19"

page.members.assigned_date

integer<int64>

unix timestamp in seconds

Example:

1608742037016

page.members.role

enum<string>

Available options:

admin,

member,

viewer

page.bookmarked

boolean

Example:

false

page.archived

object

Show child attributes

page.archived.user_id

string

Example:

"uDsu0j19"

page.archived.time_archived

integer<int64>

unix timestamp in seconds

Example:

1608742037016

page.archived.parent_page_id

string

page.is_public

boolean

Example:

false

page.public_settings

object

Show child attributes

page.public_settings.url

string

Example:

"https://pages.superthread.com/t/team/p/1"

page.public_settings.robots

enum<string>[]

Available options:

all,

index,

follow,

none,

noindex,

nofollow,

noimageindex,

nosnippet,

noarchive,

nocache,

notranslate

page.total_comments

integer

Example:

3

page.is_watching

boolean

whether current user is a watcher of this page

Example:

true

page.is_bookmarked

boolean

whether current user has this page bookmarked

Example:

true

page.hide_table_of_contents

boolean

whether to show a table of contents on page

Example:

true

page.hide_subpages

boolean

whether to show subpages section on page

Example:

true

Get a pageFetches detailed information about a specified page identified by the `page_id` within a workspace (`team_id`).

⌘I

Update a page

curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/pages/{page_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Team Page",
  "font": "<string>",
  "project_id": "3",
  "cover_image": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "id": "<string>",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup",
    "positionY": 123,
    "object_fit": "contain"
  },
  "icon": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "id": "<string>",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup"
  },
  "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",
    "icon": {
      "type": "image",
      "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",
    "cover_image": {
      "type": "image",
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "id": "<string>",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup",
      "positionY": 123,
      "object_fit": "contain"
    },
    "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": "[email protected]",
        "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": "[email protected]",
        "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
  }
}

Get started

Users

Cards

Projects

Notes

Pages

Comments

Boards

Sprints

Spaces

Search

Path Parameters

Body

Response