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
- Webhooks Actions
- Teams Actions
- Custom Filters 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.
- Archiving or unarchiving a portal to control its visibility.
- 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 you want to update. |
| Archived | Boolean flag indicating whether the portal is archived (not live) or active (live). |
| Color | Header color of the help center portal specified as a HEX color string (e.g., "#ffffff"). |
| Config | JSON configuration object specifying supported locales and the default locale. |
| Custom Domain | Custom domain URL to display the help center under a branded web address. |
| Header Text | Text displayed in the header of the help center portal. |
| Homepage Link | URL link to the main dashboard or homepage associated with the portal. |
| Name | Name of the help center portal. |
| Slug | URL slug used to display the portal in links. |
| Page Title | Title of the page shown in the browser tab or window for the portal. |
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 (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON responses.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in the credentials.
- Uses the ChatWoot REST API endpoint for updating help center portals linked to accounts.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and is correct; otherwise, the API will return an error.
- Malformed JSON in Config: The
configproperty must be valid JSON. Invalid JSON will cause parsing errors. - Unauthorized Access: Verify that the API key credential has sufficient permissions to update help center portals.
- Invalid Color Format: The
colorproperty should be a valid HEX color string; incorrect formats may be rejected. - Network Issues: Check connectivity to the ChatWoot API endpoint and ensure the base URL is correctly set.
Links and References
- ChatWoot API Documentation
- Help Center Configuration Guide
- JSON Syntax Validator (useful for validating the
configproperty)