Update a project

Updates an existing project by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}

Update a project

cURL

curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "description": "<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.

project_id · string · required

The unique identifier of the project.

Body parameters

name · string

Name of the project.

description · string

Description of the project.