Plane icon

Plane

Consume Plane API

Overview

This node operation updates an existing label within a specified project in the Plane API. It allows users to modify properties of a label such as its name, description, color, and parent label ID. This is useful for managing and organizing labels dynamically in project management workflows, enabling better categorization and filtering of issues or tasks.

Common scenarios:

  • Renaming a label to reflect updated terminology or priorities.
  • Changing the color of a label to improve visual identification.
  • Adding or changing the description to provide more context about the label's purpose.
  • Assigning or reassigning a parent label to create hierarchical label structures.

Practical example:

  • A user wants to update the "Urgent" label in their project to have a red color (#FF0000) and add a description explaining that it marks high-priority issues.

Properties

Name Meaning
Project Name or ID The identifier of the project containing the label. Choose from a list or specify via expression.
Label Name or ID The identifier of the label to update. Choose from a list filtered by the selected project or specify via expression.
Update Fields Collection of fields to update on the label:
- Name New name for the label (string).
- Description New description text for the label (string).
- Color New color for the label, specified as a hex code (e.g., #00FF00).
- Parent ID ID of the parent label to assign, allowing hierarchical organization (string).

Output

The output JSON contains the updated label object returned from the Plane API after the PATCH request. This typically includes all label properties such as:

  • id: Unique identifier of the label.
  • name: Updated name of the label.
  • description: Updated description.
  • color: Updated color hex code.
  • parent: Updated parent label ID if set.
  • Other metadata related to the label.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Plane API with appropriate authentication credentials (an API key or token).
  • The node depends on the Plane API endpoints for projects and labels.
  • The user must have permission to update labels within the specified project.

Troubleshooting

  • Error: Label not found or invalid ID
    Ensure the Label Name or ID corresponds to an existing label within the selected project. Use the dropdown or verify the ID manually.

  • Error: Unauthorized or authentication failed
    Check that the API credentials are correctly configured and have sufficient permissions to update labels.

  • Error: Invalid color format
    The color field must be a valid hex color code (e.g., #FF0000). Verify the input format.

  • Error: Parent label ID does not exist
    If specifying a parent label, ensure the ID exists within the same project.

  • General API errors
    Review the error message returned by the Plane API for details. Network issues or rate limits may also cause failures.

Links and References

Discussion