Actions63
- Comment Actions
- Cycle Actions
- Cycle Issue Actions
- Issue Actions
- Issue Attachment Actions
- Issue Property Actions
- Issue Property Option Actions
- Issue Property Value Actions
- Issue State Actions
- Label Actions
- Link Actions
- Member Actions
- Module Actions
- Module Issue Actions
- Project Actions
Overview
This node operation updates an existing issue state within a specified project in the Plane API. Issue states represent different statuses or phases that an issue can be in, such as "Backlog," "Started," or "Completed." Updating an issue state allows you to modify its properties like name, group classification, color, description, and whether it is the default state for new issues.
Common scenarios:
- Renaming an issue state to better reflect workflow changes.
- Changing the color code of a state for improved visual identification.
- Reassigning a state to a different group category (e.g., from "backlog" to "started").
- Updating the description to provide more context about the state.
- Setting a different state as the default for new issues.
Practical example:
You have a project with an issue state named "In Progress" grouped under "started" with a blue color. You want to rename it to "Development," change its color to green, and update the description to clarify that this state means active development work is ongoing. Using this node operation, you specify the project ID and state ID, then provide the updated fields accordingly.
Properties
| Name | Meaning |
|---|---|
| Project ID | The unique identifier of the project containing the issue state to update. |
| State ID | The unique identifier of the issue state to update. |
| Update Fields | A collection of fields to update on the issue state: |
| Name | The new name for the issue state. |
| Group | The group category the state belongs to. Options: Backlog, Cancelled, Completed, Started, Unstarted. |
| Color | The color code (hex) representing the state visually. |
| Description | A textual description providing details about the state. |
| Default | Boolean indicating if this state should be the default for new issues. |
Output
The output is a JSON object representing the updated issue state as returned by the Plane API. This typically includes all the properties of the issue state after the update, such as its ID, name, group, color, description, and default status.
If multiple items are processed, the output will be an array of such JSON objects corresponding to each update operation.
The node does not output binary data for this operation.
Dependencies
- Requires access to the Plane API with appropriate authentication credentials (an API key or token).
- The node expects the Plane API credential to be configured in n8n.
- Network connectivity to the Plane API endpoint is necessary.
Troubleshooting
- Missing or invalid Project ID or State ID: The node requires valid identifiers to locate the issue state. Ensure these IDs are correct and correspond to existing resources in your Plane project.
- Insufficient permissions: The API key used must have permission to update issue states in the specified project.
- Invalid field values: For example, setting a group value outside the allowed options or providing an invalid color code may cause errors.
- API errors: If the Plane API returns an error (e.g., 404 Not Found or 400 Bad Request), verify the input parameters and the current state of the resource.
- Network issues: Connectivity problems can cause request failures; check your network and proxy settings if applicable.