Skip to main content
PATCH
/
api
/
v1
/
workspaces
/
{workspace_slug}
/
projects
/
{project_id}
/
modules
/
{module_id}
/
Update module details
curl --request PATCH \
  --url https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/{module_id}/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "start_date": "<string>",
  "target_date": "<string>",
  "status": "<string>",
  "lead": "<string>",
  "members": [
    "<string>"
  ],
  "external_source": "<string>",
  "external_id": "<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.
​
module_id
string
required
The unique identifier for the module.

​
Body parameters

​
name
string
Name of the module.
​
description
string
Description of the module.
​
start_date
string
Start date of the module in YYYY-MM-DD format.
​
target_date
string
Target date of the module in YYYY-MM-DD format.
​
status
string
Current status of the module. Possible values: backlog, planned, in-progress, paused, completed, cancelled.
​
lead
string
ID of the user who leads the module.
​
members
string[]
Array of member user IDs assigned to the module.
​
external_source
string
External source identifier.
​
external_id
string
External ID from the external source.