ChatWoot icon

ChatWoot

Interact with ChatWoot API
Join our community

Actions113

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, a company managing product documentation can create categories such as "Sales," "Engineering," or language-specific categories to better organize their help articles.

Typical use cases include:

  • Adding a new product documentation category under a specific account and portal.
  • Creating localized categories for different languages.
  • Structuring categories hierarchically by defining parent categories.
  • Associating similar categories across different locales or portals.

Properties

Name Meaning
Account Id The numeric ID of the account where the 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 identifier for the category.
Position Numeric position used to sort the category in the portal's 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 hierarchical category structures.

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 API key credential for authenticating with the ChatWoot API or the relevant Help Center service.
  • The base URL for the API must be configured in the node credentials.
  • The node uses HTTP requests with JSON payloads to interact with the external Help Center API.

Troubleshooting

  • Missing Required Fields: Ensure that Account Id and Portal Id are provided and valid numeric values; otherwise, the API may reject the request.
  • Invalid Locale or Slug: Using unsupported locale codes or invalid slug formats might cause errors.
  • API Authentication Errors: Verify that the API key or authentication token is correctly set up in the node credentials.
  • Parent or Associated Category IDs: If these IDs do not exist or belong to another account/portal, the API may return errors.
  • Position Conflicts: Duplicate positions might affect sorting; verify the position value if ordering issues arise.

Links and References

Discussion