Plane icon

Plane

Consume Plane API

Overview

This node interacts with the Plane API to manage issue property options within a project management context. Specifically, the "Update" operation for the "Issue Property Option" resource allows users to modify attributes of an existing option associated with an issue property in a given project.

Use cases include updating the name, description, sort order, activation status, default status, or hierarchical parent of an option that categorizes or qualifies issues. This is beneficial when refining issue properties to better reflect evolving project requirements or workflows.

For example, if you have a dropdown property for issue priority levels, you can update an option's name from "High" to "Urgent," change its sort order to appear first, or mark it as the default choice.

Properties

Name Meaning
Project ID The unique identifier of the project containing the issue property option.
Property ID The unique identifier of the issue property to which the option belongs.
Option ID The unique identifier of the specific issue property option to update.
Update Fields A collection of fields to update on the option:
- Name New name for the option.
- Description New description text for the option.
- Sort Order Numeric value defining the display order of the option (default is 10000).
- Is Active Boolean indicating whether the option is active and available for selection.
- Is Default Boolean indicating whether this option should be the default selection.
- Parent ID Identifier of a parent option to create nested/hierarchical options under this one.

Output

The output JSON contains the updated issue property option object returned by the Plane API after the PATCH request. This typically includes all current fields of the option such as its ID, name, description, sort order, active status, default status, and parent relationship.

No binary data output is involved in this operation.

Dependencies

  • Requires access to the Plane API via an authenticated API key credential configured in n8n.
  • The node uses internal helper functions to make HTTP requests to Plane API endpoints.
  • The user must provide valid IDs for the project, issue property, and option to update.

Troubleshooting

  • Missing Required Parameters: Ensure that Project ID, Property ID, and Option ID are provided; otherwise, the API call will fail.
  • Invalid Option ID: If the Option ID does not exist or does not belong to the specified property/project, the API will return an error.
  • Permission Issues: The API key used must have sufficient permissions to update issue property options.
  • API Errors: Network issues or Plane API downtime may cause request failures.
  • Incorrect Field Types: For example, providing a non-boolean value for "Is Active" or "Is Default" may cause validation errors.

To resolve errors, verify all input parameters, check API credentials, and consult Plane API documentation for error codes.

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 for issue properties and options (refer to Plane product resources)

Discussion