Plane icon

Plane

Consume Plane API

Overview

The node integrates with the Plane API to manage projects and their related entities. Specifically, for the Project - Update operation, it updates an existing project's details such as its name, description, and network visibility.

This node is useful in scenarios where you need to programmatically modify project metadata within a workflow automation, for example:

  • Renaming a project after a rebranding.
  • Updating the project description to reflect new goals or status.
  • Changing the project's network visibility from public to private or vice versa.

Properties

Name Meaning
Project ID The unique identifier of the project to update (required).
Update Fields A collection of fields to update on the project:
  Name New name for the project.
  Description New description text for the project.
  Network Network visibility setting for the project. Options: Public (2), Private (0).

Output

The output JSON contains the updated project object returned by the Plane API after the PATCH request. This typically includes the project's current state with updated fields such as name, description, network, and other metadata managed by the Plane system.

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 HTTP requests to the Plane API endpoints.
  • No additional external services are required specifically for the Project Update operation.

Troubleshooting

  • Missing or invalid Project ID: The operation requires a valid project ID. Ensure the ID exists and is correctly provided.
  • Invalid field values: For example, the network field only accepts specific numeric values (0 or 2). Providing unsupported values may cause errors.
  • API authentication errors: Verify that the API key credential is correctly set up and has permissions to update projects.
  • Network issues: Connectivity problems can cause request failures; check your network and Plane API availability.
  • Partial updates: Only fields included in "Update Fields" will be changed; omitting required fields might lead to incomplete updates.

Common error messages usually come directly from the Plane API and should be interpreted accordingly. If the node throws an error about missing parameters or failed requests, verify input correctness and API access rights.

Links and References

Discussion