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>"
}
'import requests
url = "https://api.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/"
payload = {
"name": "<string>",
"description_json": {},
"description_html": "<string>",
"description_stripped": "<string>",
"description_binary": "<string>",
"logo_props": {},
"lead": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description_json: {},
description_html: '<string>',
description_stripped: '<string>',
description_binary: '<string>',
logo_props: {},
lead: '<string>'
})
};
fetch('https://api.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_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.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_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([
'name' => '<string>',
'description_json' => [
],
'description_html' => '<string>',
'description_stripped' => '<string>',
'description_binary' => '<string>',
'logo_props' => [
],
'lead' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description_json\": {},\n \"description_html\": \"<string>\",\n \"description_stripped\": \"<string>\",\n \"description_binary\": \"<string>\",\n \"logo_props\": {},\n \"lead\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description_json\": {},\n \"description_html\": \"<string>\",\n \"description_stripped\": \"<string>\",\n \"description_binary\": \"<string>\",\n \"logo_props\": {},\n \"lead\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description_json\": {},\n \"description_html\": \"<string>\",\n \"description_stripped\": \"<string>\",\n \"description_binary\": \"<string>\",\n \"logo_props\": {},\n \"lead\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyTeamspaces
Update a teamspace
Updates an existing teamspace by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
PATCH
/
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>"
}
'import requests
url = "https://api.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/"
payload = {
"name": "<string>",
"description_json": {},
"description_html": "<string>",
"description_stripped": "<string>",
"description_binary": "<string>",
"logo_props": {},
"lead": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description_json: {},
description_html: '<string>',
description_stripped: '<string>',
description_binary: '<string>',
logo_props: {},
lead: '<string>'
})
};
fetch('https://api.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_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.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_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([
'name' => '<string>',
'description_json' => [
],
'description_html' => '<string>',
'description_stripped' => '<string>',
'description_binary' => '<string>',
'logo_props' => [
],
'lead' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description_json\": {},\n \"description_html\": \"<string>\",\n \"description_stripped\": \"<string>\",\n \"description_binary\": \"<string>\",\n \"logo_props\": {},\n \"lead\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description_json\": {},\n \"description_html\": \"<string>\",\n \"description_stripped\": \"<string>\",\n \"description_binary\": \"<string>\",\n \"logo_props\": {},\n \"lead\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.plane.so/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description_json\": {},\n \"description_html\": \"<string>\",\n \"description_stripped\": \"<string>\",\n \"description_binary\": \"<string>\",\n \"logo_props\": {},\n \"lead\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyPath parameters
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.string
required
The unique identifier for the teamspace.
Body parameters
string
Name of the teamspace.
object
JSON representation of the teamspace description.
string
HTML-formatted description of the teamspace.
string
Stripped version of the HTML description.
string
Binary representation of the description.
object
Logo properties for the teamspace
string
ID of the user who leads the teamspace.