Outline icon

Outline

Interact with Outline knowledge base
Join our community

Actions53

Overview

This node interacts with the Outline knowledge base API, allowing users to manage various resources such as groups, documents, collections, users, and more. Specifically, for the Group - Update operation, it updates the name of an existing group identified by its Group ID.

Use cases include:

  • Renaming a group in your Outline knowledge base to reflect organizational changes.
  • Correcting typos or updating group names for clarity.
  • Automating group management workflows where group details need periodic updates.

Example: You have a group called "Marketing Team" but want to rename it to "Global Marketing Team" programmatically via n8n.

Properties

Name Meaning
Group ID The unique identifier of the group you want to update.
Group Name The new name to assign to the group.

Output

The node outputs the JSON response from the Outline API after updating the group. This typically includes the updated group's details such as its ID, new name, and other metadata returned by the API.

The output is structured as:

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

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authenticating with the Outline knowledge base API.
  • The node uses the Outline API endpoints, so network access to the Outline service is necessary.
  • Proper configuration of the API authentication credential in n8n is required.

Troubleshooting

  • Common issues:

    • Invalid or missing Group ID: Ensure the Group ID provided exists and is correct.
    • Insufficient permissions: The API key used must have rights to update groups.
    • Network or API errors: Check connectivity and API status.

  • Error messages:

    • "Group not found": The specified Group ID does not exist. Verify the ID.
    • "Unauthorized" or "Authentication failed": The API key is invalid or lacks permission.
    • "Invalid parameters": The Group Name might be missing or invalid; ensure it is provided.

To resolve errors, verify input parameters, check API credentials, and confirm network connectivity.

Links and References

Discussion