Update a teamspace

PATCH/api/v1/workspaces/{workspace_slug}/teamspaces/{teamspace_id}/

Update a teamspace by its ID. Send only the fields you want to change.

Requires the teamspace lead, or a workspace Owner or Admin. If you set lead to a user who is not a member, that user becomes a member.

The serializer also accepts created_by and updated_by. Leave them out. The server records the caller.

Path Parameters

workspace_slug:requiredstring

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:requiredstring

The unique identifier of the teamspace.

Body Parameters

name:optionalstring

Name of the teamspace.

description_html:optionalstring

HTML description of the teamspace.

description_json:optionalobject

JSON description of the teamspace. Send an object, not a string.

description_stripped:optionalstring

Plain-text version of the description.

logo_props:optionalobject

Logo of the teamspace. Send an object with in_use set to emoji or icon, plus a matching emoji or icon object.

lead:optionalstring

ID of the user who leads the teamspace. Send null to clear the lead.

Scopes

write or teamspaces:write

Update a teamspace

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Platform Team",
  "lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/",
    headers={"X-API-Key": "your-api-key"},
    json={
      "name": "Platform Team",
      "lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
    }
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/teamspaces/teamspace-uuid/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Platform Team",
      lead: "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
    }),
  },
);
const data = await response.json();

Response200

{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "created_at": "2023-11-19T11:56:55.176802Z",
  "updated_at": "2023-11-20T09:12:41.001233Z",
  "deleted_at": null,
  "name": "Platform Team",
  "description_json": {},
  "description_html": "<p>Engineering team workspace</p>",
  "description_stripped": "Engineering team workspace",
  "description_binary": null,
  "logo_props": {
    "in_use": "emoji",
    "emoji": {
      "value": "1f680"
    }
  },
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "lead": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}