Skip to main content
PATCH
https://api.plane.so
/
api
/
v1
/
workspaces
/
{workspace_slug}
/
teamspaces
/
{teamspace_id}
Update a teamspace
curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description_json": {},
  "description_html": "<string>",
  "description_stripped": "<string>",
  "description_binary": "<string>",
  "logo_props": {},
  "lead": "<string>"
}
'

​
Path parameters

​
workspace_slug
string
required
The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.
​
teamspace_id
string
required
The unique identifier for the teamspace.

​
Body parameters

​
name
string
Name of the teamspace.
​
description_json
object
JSON representation of the teamspace description.
​
description_html
string
HTML-formatted description of the teamspace.
​
description_stripped
string
Stripped version of the HTML description.
​
description_binary
string
Binary representation of the description.
​
logo_props
object
Logo properties for the teamspace
​
lead
string
ID of the user who leads the teamspace.