Create a module

POST/api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/

Creates a new module in a project.

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.

project_id:requiredstring

The unique identifier of the project.

Body Parameters

name:requiredstring

Name of the module.

description:optionalstring

Description of the module.

start_date:optionalstring

Start date of the module in YYYY-MM-DD format.

target_date:optionalstring

Target date of the module in YYYY-MM-DD format.

status:optionalstring

Status of the module. Possible values: backlog, planned, in-progress, paused, completed, cancelled.

lead:optionalstring

ID of the user who leads the module.

members:optionalstring[]

Array of member user IDs to assign to the module.

external_source:optionalstring

External source identifier.

external_id:optionalstring

External ID from the external source.

Scopes

projects.modules:write

Create a module

curl -X POST \  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/" \  -H "X-API-Key: $PLANE_API_KEY" \  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \  -H "Content-Type: application/json" \  -d '{  "name": "example-name",  "description": "example-description",  "start_date": "example-start_date",  "target_date": "example-target_date",  "status": "example-status",  "lead": "example-lead",  "members": "example-members",  "external_source": "example-external_source",  "external_id": "example-external_id" }'

import requests  response = requests.post(  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/",  headers={"X-API-Key": "your-api-key"},  json={  'name': 'example-name',  'description': 'example-description',  'start_date': 'example-start_date',  'target_date': 'example-target_date',  'status': 'example-status',  'lead': 'example-lead',  'members': 'example-members',  'external_source': 'example-external_source',  'external_id': 'example-external_id' } ) print(response.json())

const response = await fetch("https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/modules/", {  method: "POST",  headers: {  "X-API-Key": "your-api-key",  "Content-Type": "application/json",  },  body: JSON.stringify({  name: "example-name",  description: "example-description",  start_date: "example-start_date",  target_date: "example-target_date",  status: "example-status",  lead: "example-lead",  members: "example-members",  external_source: "example-external_source",  external_id: "example-external_id",  }), }); const data = await response.json();

Response201

{  "id": "project-uuid",  "name": "Project Name",  "identifier": "PROJ",  "description": "Project description",  "created_at": "2024-01-01T00:00:00Z" }