Planka icon

Planka

Interact with Planka API

Overview

The Update User operation in the Planka n8n node allows you to modify the details of an existing user within your Planka instance. This is useful for administrative tasks such as updating a user's contact information, changing their role (admin or not), adjusting language preferences, or managing their notification settings.

Common scenarios:

  • Keeping user profiles up-to-date when employees change their email, phone, or organization.
  • Granting or revoking admin privileges.
  • Automating onboarding/offboarding processes by integrating with HR or IT systems.
  • Adjusting user notification preferences programmatically.

Example use case:
When a user's details change in your HR system, you can trigger this node to automatically update the corresponding user record in Planka, ensuring consistency across platforms.


Properties

Name Type Meaning
User ID string The unique identifier of the user to be updated.
Email string The new email address for the user.
Name string The full name of the user.
Username string The username for login and identification within Planka.
Phone string The user's phone number.
Organization string The organization or company the user belongs to.
Language string The user's preferred language for the interface.
Subscribe to Own Cards boolean Whether the user should be subscribed to notifications about cards they create.
Is Admin boolean Whether the user has administrator privileges.

Output

The output will be a JSON object representing the updated user. The structure typically includes all user fields after the update, such as:

{
  "id": "string",
  "name": "string",
  "email": "string",
  "username": "string",
  "phone": "string",
  "organization": "string",
  "language": "string",
  "subscribeToOwnCards": true,
  "isAdmin": false,
  // ...other user-related fields
}

If an error occurs and "Continue On Fail" is enabled, the output will include an error field with the error message.


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 are required beyond standard credential setup.

Troubleshooting

Common issues:

  • Invalid User ID: If the provided User ID does not exist, the API will return an error.
  • Missing Required Fields: Omitting required properties (e.g., Email, Name) will result in validation errors.
  • Permission Denied: The API credentials used may lack permission to update users.
  • Network/API Errors: Connectivity issues or incorrect API base URL configuration can cause failures.

Error messages:

  • "User not found": Check that the User ID is correct and exists in Planka.
  • "Validation failed": Ensure all required fields are provided and correctly formatted.
  • "Unauthorized": Verify that your API credentials are valid and have sufficient permissions.

Links and References


Discussion