Actions113
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Inbox API Actions
- Contacts API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Canned Response Actions
- Custom Attributes Actions
- Contacts Actions
- Contact Actions
- Automation Rule Actions
- Help Center Actions
- Conversations Actions
- Conversation Assignment Actions
- Conversation Labels Actions
- Inboxes Actions
- Messages Actions
- Integrations Actions
- Teams Actions
- Custom Filters Actions
- Webhooks Actions
- Reports Actions
Overview
This node integrates with the ChatWoot Help Center API to update the configuration of a "New Portal" associated with a specific account. It allows users to modify various settings of the help center portal such as its appearance, localization options, domain, and status (archived or live). This is useful for organizations that want to programmatically manage their customer support portals, customize branding, or enable/disable portals without manual intervention.
Practical examples:
- Automatically updating the header color and text of the help center portal when rebranding.
- Changing the supported languages or default locale based on user preferences or region.
- Archiving or unarchiving a portal to control its availability.
- Setting a custom domain for the help center to match company branding.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account whose help center portal is being updated. |
| Archived | Boolean flag indicating whether the portal is archived (not live) or active (live). |
| Color | Hexadecimal color string for the header color of the help center portal. |
| Config | JSON object defining locale configurations, including allowed locales and default locale. |
| Custom Domain | URL string specifying a custom domain to display the help center under. |
| Header Text | Text string displayed in the header of the help center portal. |
| Homepage Link | URL string linking to the main dashboard or homepage from the help center. |
| Name | Name of the help center portal. |
| Slug | URL slug used in the portal's link for identification. |
| Page Title | Title text shown on the portal's page. |
Output
The node outputs JSON data representing the updated state of the help center portal after applying the changes. This typically includes all the properties sent in the request along with any additional metadata returned by the ChatWoot API confirming the update.
If the API supports binary data output (e.g., images or files), it would be summarized accordingly, but based on this operation, the output is purely JSON.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in credentials.
- Depends on the ChatWoot Help Center API endpoint for updating portal settings.
Troubleshooting
Common issues:
- Invalid or missing Account Id will cause the update to fail.
- Incorrect JSON format in the
configproperty may result in parsing errors. - Providing an invalid hex color string could lead to UI rendering issues.
- Network or authentication failures if API key or base URL are misconfigured.
Error messages and resolutions:
- "Unauthorized" — Check that the API key credential is valid and has necessary permissions.
- "Invalid input data" — Verify all required fields are provided and correctly formatted, especially JSON config.
- "Account not found" — Confirm the Account Id exists in the ChatWoot system.
- "Failed to connect" — Ensure network connectivity and correct base URL configuration.