Plane icon

Plane

Consume Plane API

Actions63

Overview

This node interacts with the Plane API to manage project modules. Specifically, the Module - Update operation allows updating details of a module within a specified project. This is useful in scenarios where you need to modify module attributes such as its name, description, dates, status, lead, or members dynamically as project requirements evolve.

Practical examples include:

  • Changing the status of a module from "planned" to "in-progress".
  • Updating the start or target completion dates for better scheduling.
  • Assigning a new lead or modifying the list of members involved in the module.
  • Editing the module's descriptive information to reflect scope changes.

Properties

Name Meaning
Project ID The unique identifier of the project containing the module to update.
Module ID The unique identifier of the module to be updated.
Update Fields A collection of fields that can be updated on the module:
- Name: New name of the module.
- Description: Textual description of the module.
- Start Date: The date and time when the module is planned to start.
- Target Date: The estimated completion date and time for the module.
- Status: Current state of the module. Options are: Backlog, Cancelled, Completed, In Progress, Paused, Planned.
- Lead: User ID of the person leading the module.
- Members: Comma-separated string of user IDs who are members of this module.

Output

The output JSON contains the updated module object returned by the Plane API after the PATCH request. This typically includes all current properties of the module reflecting the applied updates.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Plane API via an API key credential configured in n8n.
  • The node uses internal helper functions to make authenticated HTTP requests to the Plane API endpoints.
  • The projectId and moduleId must correspond to existing entities in the Plane system.

Troubleshooting

  • Invalid Project or Module ID: If the provided projectId or moduleId does not exist or is incorrect, the API will return an error. Verify these IDs before running the node.
  • Invalid Field Values: Providing invalid values for fields like status (not one of the allowed options) or malformed dates may cause the update to fail.
  • API Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to update modules.
  • Members Field Format: The members field must be a comma-separated string of user IDs. Incorrect formatting may result in errors or ignored updates.
  • Partial Updates: Only fields included in updateFields are changed; omitting required fields or sending empty objects may result in no changes or errors.

Links and References

  • Plane API Documentation (general reference for endpoints and data models)
  • n8n documentation on HTTP Request Node for understanding API calls
  • Plane project management concepts: modules, projects, users (refer to Plane official docs)

This summary focuses exclusively on the Module - Update operation as requested, based on static analysis of the provided source code and property definitions.

Discussion