Planka icon

Planka

Interact with Planka API

Overview

The Update Attachment operation for the 📝 CARD resource in this n8n node allows you to update the metadata (specifically, the name) of an existing attachment on a card within the Planka project management platform. This is useful when you need to rename an attachment without re-uploading or replacing the file itself.

Common scenarios:

  • Correcting typos or updating the description in an attachment's name.
  • Standardizing attachment naming conventions across your workflow.
  • Automating updates to attachment names based on other workflow data.

Practical example:
Suppose you have a workflow that attaches files to cards and later needs to update their names to include a version number or status. This operation enables you to automate such renaming tasks.


Properties

Name Type Meaning
Attachment ID String The unique identifier of the attachment to update. Required to specify which attachment will be modified.
Attachment Name String The new name to assign to the attachment. This will replace the current name.

Output

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

{
  "id": "string",
  "name": "string",
  "cardId": "string",
  "createdAt": "string",
  "updatedAt": "string",
  // ...other attachment metadata
}
  • id: The ID of the attachment.
  • name: The updated name of the attachment.
  • cardId: The ID of the card the attachment belongs to.
  • Timestamps and possibly other metadata depending on the Planka API response.

Note: No binary data is returned; only metadata about the attachment is provided.


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: Ensure the node has network access to the Planka server.

Troubleshooting

Common issues:

  • Invalid Attachment ID: If the provided Attachment ID does not exist, the API will likely return a "Not Found" error.
  • Missing Permissions: If the API credentials do not have permission to modify attachments, you may receive a "Forbidden" or "Unauthorized" error.
  • Empty or Invalid Name: Providing an empty or invalid name may result in a validation error from the API.

Error messages and resolutions:

  • "Attachment not found": Check that the Attachment ID is correct and exists on the specified card.
  • "Unauthorized" or "Forbidden": Verify your API credentials and permissions.
  • "Validation failed": Ensure the new name meets any requirements set by Planka (e.g., not empty).

Links and References


Discussion