Planka icon

Planka

Interact with Planka API

Overview

The Update Board List operation for the 📋 BOARD resource in this n8n node allows you to modify an existing list within a board on the Planka platform. This is useful when you need to change the name, position, or color of a list (column) in a Kanban-style board programmatically as part of your workflow automation.

Common scenarios:

  • Renaming a list to reflect new project phases.
  • Reordering lists based on priority or workflow changes.
  • Changing the color of a list for better visual organization.

Practical example:
Suppose you have a workflow that automatically updates the "In Progress" list to "Ongoing Tasks" and moves it to the top whenever a sprint starts. This operation enables such dynamic board management.


Properties

Name Type Meaning
List ID String The unique identifier of the board list to update.
Name String The new name for the list.
Position Number The new position/order of the list within the board.

All properties are required except "Position", which defaults to 1 if not specified.


Output

The output will be a JSON object representing the updated board list. While the exact structure depends on the Planka API response, it typically includes fields such as:

{
  "id": "string",
  "name": "string",
  "position": number,
  "color": "string",
  // ...other metadata fields
}
  • id: The unique identifier of the list.
  • name: The updated name of the list.
  • position: The updated position of the list.
  • color: The color assigned to the list (if applicable).

No binary data is returned by this operation.


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.
  • n8n Configuration: No special environment variables beyond standard credential setup.

Troubleshooting

Common issues:

  • Invalid List ID: If the provided List ID does not exist, the API will return an error. Double-check the List ID.
  • Missing Required Fields: Omitting required fields like Name may result in validation errors from the API.
  • Insufficient Permissions: The API credentials must have permission to update lists on the target board.

Error messages:

  • "List not found": The List ID is incorrect or the list has been deleted.
  • "Unauthorized": The API credentials are missing or invalid.
  • "Validation failed": One or more input fields do not meet the API's requirements.

How to resolve:

  • Ensure all required fields are filled and correct.
  • Verify your API credentials and permissions.
  • Check the Planka API documentation for field constraints.

Links and References


Discussion