Skip to main content
PATCH
/
{team_id}
/
projects
/
{project_id}
Update a project
curl --request PATCH \
  --url https://api.superthread.com/v1/{team_id}/projects/{project_id} \
  --header 'Content-Type: application/json' \
  --data '{
  "title": "updated project title",
  "description": "updated project description",
  "icon": {
    "type": "image",
    "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
    "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
    "color": "black",
    "emoji": "thumbsup"
  },
  "is_private": true,
  "position": 3,
  "overview_page_id": "22",
  "estimate_system": "fibonacci",
  "is_view_only": true
}'
{
  "project": {
    "id": "421",
    "team_id": "tDsu0j19",
    "title": "My Project",
    "description": "<string>",
    "icon": {
      "type": "image",
      "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
      "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
      "color": "black",
      "emoji": "thumbsup"
    },
    "overview_page_id": "<string>",
    "user_id": "u-dsu0j19",
    "user_id_updated": "uDsu0j19",
    "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
      }
    },
    "time_created": 1608742037016,
    "time_updated": 1608742037016,
    "time_expires": 1608742037016,
    "members": [
      {
        "user_id": "u-dsu0j19",
        "assigned_date": 1608742037016,
        "role": "admin"
      }
    ],
    "is_member": true,
    "total_members": 7,
    "total_members_online": 2,
    "is_public": true,
    "is_private": true,
    "page_order": [
      {}
    ],
    "pages": [
      {
        "id": "<string>",
        "title": "<string>",
        "icon": {
          "type": "image",
          "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
          "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
          "color": "black",
          "emoji": "thumbsup"
        }
      }
    ],
    "trashed": {
      "user_deleted": {
        "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
        }
      },
      "time_deleted": 1608742037016
    },
    "archive_page_order": [
      {}
    ],
    "archive_pages": [
      {
        "id": "<string>",
        "title": "<string>",
        "icon": {
          "type": "image",
          "src": "data:image/png;base64, iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==",
          "blurhash": "LEHV6nWB2yk8pyoJadR*.7kCMdnj",
          "color": "black",
          "emoji": "thumbsup"
        }
      }
    ],
    "board_order": {},
    "boards": [
      {
        "id": "<string>",
        "title": "<string>"
      }
    ],
    "sprints": [
      {
        "id": "<string>",
        "title": "<string>",
        "start_date": 1608742037016,
        "end_date": 1608742037016
      }
    ],
    "estimate_system": "",
    "is_view_only": 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".

​
project_id
string
required

Project ID is a numerical string that identifies a Project. This is externally referred to as a "Space".

Body

application/json

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

​
title
string | null
Example:

"updated project title"

​
description
string | null
Example:

"updated project description"

​
icon
object
​
is_private
boolean | null

Toggle project privacy.

​
position
integer | null

a position where the project should be placed in the sidebar

Example:

3

​
overview_page_id
string | null
Example:

"22"

​
estimate_system
enum<string> | null

pass an empty string to unset

Available options:
,
fibonacci,
tshirt,
exponential
Example:

"fibonacci"

​
is_view_only
boolean | null

Response

updated project response

​
project
object
⌘I