Planka

Interact with Planka API

Actions46

Overview

The Update Board Label operation for the 📋 BOARD resource in this n8n node allows you to modify an existing label on a Planka board. This is useful for keeping your board labels up-to-date, such as changing their name or color to reflect new workflows or organizational standards.

Common scenarios:

Renaming a label after a process change (e.g., "In Review" to "QA").
Changing the color of a label for better visual distinction.
Automating label updates as part of a larger workflow when project requirements evolve.

Practical example:
If your team decides to standardize label colors across all boards, you can use this operation in an automation to update all relevant labels with the correct color codes.

Properties

Name	Type	Meaning
Label ID	String	The unique identifier of the label you want to update.
Name	String	The new name for the label. Leave empty if you do not wish to change the label's name.
Color	String	The new color for the label, in hexadecimal format (e.g., `#FF0000` for red).

Output

The output will be a JSON object representing the updated label. The structure typically includes fields such as:

{
  "id": "string",
  "name": "string",
  "color": "string",
  // ...other label properties as returned by the Planka API
}

id: The label's unique identifier.
name: The updated name of the label.
color: The updated color in hexadecimal format.

Note: The exact structure may include additional fields depending on the Planka API response.

Dependencies

External Service: Requires access to a running Planka instance with API enabled.
Authentication: Needs valid Planka API credentials configured in n8n under the credential type plankaApi.

Troubleshooting

Common issues:

Invalid Label ID: If the provided Label ID does not exist, the API will return an error. Double-check the ID.
Missing Required Fields: The Label ID and Color are required. Ensure these are provided.
Invalid Color Format: The color must be a valid hexadecimal string (e.g., #4680FF). Invalid formats will cause errors.
Insufficient Permissions: The user associated with the API key must have permission to edit labels on the target board.

Error messages you might see:

"Label not found": The Label ID does not exist or is not accessible.
"Invalid color format": The color value is not a valid hex code.
"Unauthorized": Check your API credentials and permissions.