Actions113
- 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
- Accounts Actions
- Account Users Actions
- Agent Bots Actions
- Users Actions
- Contacts API Actions
- Inbox API Actions
- Conversations API Actions
- Messages API Actions
- CSAT Survey Page Actions
- Account Agent Bots Actions
- Agents Actions
- Canned Responses Actions
- Custom Attributes Actions
- Canned Response 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 their help center portal such as appearance, localization, domain, and status (archived or live). This is useful for organizations that want to programmatically manage their customer support portals, keeping them up-to-date with branding changes, localization preferences, or operational status.
Practical examples:
- Automatically updating the header color and text of the help center portal when rebranding.
- Changing the portal’s default language and supported locales based on user preferences.
- Archiving or unarchiving the portal to control its visibility without deleting it.
- 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 | 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 in the portal’s link for identification. |
| 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 node supports binary data output, it would relate to attachments or media associated with the portal, but this operation focuses on JSON configuration updates only.
Dependencies
- Requires an API key credential for authenticating with the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in the credentials.
- The node uses the ChatWoot REST API endpoint for updating help center portals linked to accounts.
Troubleshooting
- Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will return an error. Verify the account ID before running the node.
- Authentication Errors: Ensure the API key credential is valid and has sufficient permissions to update help center portals.
- Malformed JSON in Config: The
configproperty expects a valid JSON string. Invalid JSON will cause parsing errors. Use proper JSON formatting. - Invalid Color Format: The
colorproperty must be a valid HEX color string. Incorrect formats may be rejected by the API. - Network Issues: Connectivity problems with the ChatWoot server will prevent updates. Check network access and base URL correctness.
Links and References
- ChatWoot API Documentation
- Help Center Portal Configuration Guide
- JSON Syntax Validator (useful for validating the
configproperty)