Planka

Interact with Planka API

Actions46

Overview

The Update Project operation for the 🏢 PROJECT resource in this n8n node allows you to update details of an existing project in Planka. This includes changing the project's name, background settings (name, type, and image), and other related attributes.

Common scenarios:

Renaming a project as it evolves.
Changing the visual appearance of a project by updating its background.
Automating project updates as part of a workflow when certain triggers occur (e.g., after approval, change project branding).

Practical example:
You might use this node in a workflow where, after a project is reviewed and approved, its name and background are updated to reflect its new status or branding guidelines.

Properties

Name	Type	Meaning
Project ID	String	The unique identifier of the project to update.
Name	String	The new name for the project.
Background Name	String	The display name for the project's background.
Background Type	Options	The type of background ("Gradient" or "Image").
Background Image	String	The URL of the background image to use if "Image" is selected as type.

Output

The output will be a JSON object representing the updated project as returned by the Planka API. The structure typically includes fields such as:

{
  "id": "string",
  "name": "string",
  "background": "string",
  "backgroundType": "string",
  "backgroundImage": "string",
  // ...other project properties
}

All fields reflect the current state of the project after the update.
If multiple items are processed, the output will be an array of such objects.

Dependencies

Planka API: Requires access to a running Planka instance with API enabled.
API Credentials: You must configure the plankaApi credentials in n8n for authentication.
n8n Configuration: No special environment variables beyond standard credential setup.

Troubleshooting

Common issues:

Invalid Project ID: If the provided Project ID does not exist, the API will return an error.
Missing Required Fields: Omitting required fields like "Project ID" or "Name" will result in validation errors.
Authentication Errors: Incorrect or missing API credentials will cause authentication failures.

Error messages and resolutions:

"Project not found": Check that the Project ID is correct and exists in Planka.
"Missing required parameter: name": Ensure the "Name" property is provided.
"Unauthorized": Verify your Planka API credentials in n8n.