Planning

Create a module

Group related work into a module with a lead, members, dates, and a delivery status.

post/workspaces/{workspace_slug}/projects/{project_id}/modules/

Request

  • Base URL: https://api.plane.so/api/v1
  • URL: https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/modules/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.plane.so/auth/o/authorize-app/, token URL https://api.plane.so/auth/o/token/; client credentials, token URL https://api.plane.so/auth/o/token/, scopes: projects.modules:write)

Path parameters

workspace_slugstring required

Workspace identifier from the workspace URL. In https://app.plane.so/my-team/projects/ it is my-team.

project_idstring uuid required

The project the resource belongs to.

Request body

namestring required
descriptionstring
status'backlog' | 'planned' | 'in-progress' | 'paused' | 'completed' | 'cancelled'
leadstring uuid
membersstring[]
start_datestring date
target_datestring date
external_sourcestring
external_idstring

Response

The created module.

idstring uuid required
namestring required
descriptionstring nullable
status'backlog' | 'planned' | 'in-progress' | 'paused' | 'completed' | 'cancelled'
leadstring uuid nullable
membersstring[]
start_datestring date nullable
target_datestring date nullable
projectstring uuid
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.