ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Help Center → Add New Category To Account

AI-generated

Overview

This node operation allows you to add a new category to a Help Center account within a portal. It is useful for organizing content in a structured way by creating categories that group related articles or documentation. For example, you might use this node to create categories such as "Product Documentation," "FAQs," or "Troubleshooting" under a specific account and portal in your Help Center system.

Common scenarios include:

  • Structuring a knowledge base by adding new categories dynamically.
  • Managing multilingual support by associating categories across different locales.
  • Organizing hierarchical categories with parent-child relationships for better navigation.

Properties

Name Meaning
Account Id The numeric ID of the account where the new category will be added.
Portal Id The numeric ID of the portal associated with the category.
Description A textual description of the category.
Locale The locale/language code for the category (e.g., "en", "es").
Name The name/title of the category.
Slug A URL-friendly string identifier for the category.
Position Numeric position to sort the category within the portal's category list.
Associated Category Id Numeric ID to associate this category with similar categories (e.g., same category in different languages).
Parent Category Id Numeric ID of a parent category to create a hierarchy (e.g., subcategories under a main category).

Output

The node outputs JSON data representing the newly created category object returned from the API. This typically includes details such as the category ID, name, description, locale, slug, position, and any associations or parent-child relationships established.

No binary data output is involved in this operation.

Dependencies

  • Requires an active connection to the Help Center API endpoint.
  • Needs an API authentication token or key configured in the node credentials to authorize requests.
  • The base URL for the API must be set correctly in the node credentials or environment configuration.

Troubleshooting

  • Missing Required Fields: Ensure that Account Id and Portal Id are provided and valid numeric values; these are mandatory.
  • Invalid Locale or Slug: Provide valid locale codes and URL-friendly slugs to avoid API validation errors.
  • Authentication Errors: Verify that the API key or token used has sufficient permissions to create categories.
  • API Endpoint Issues: Confirm the base URL and network connectivity to the Help Center API.
  • Position Conflicts: If the position number conflicts with existing categories, the API may reorder or reject the request; adjust accordingly.

Links and References

Discussion