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
Help Center → Update New Portal To Account
AI-generatedOverview
This node operation updates the settings of a "New Portal" associated with a specific account in a Help Center system. It allows users to modify various portal attributes such as its name, appearance, localization settings, and domain configuration. This is useful for administrators or support teams who want to customize the help center portal experience for their customers or internal users.
Practical examples include:
- Changing the header color and text of the help center portal to match company branding.
- Updating the portal's default language and supported locales.
- Setting a custom domain for the help center.
- Archiving or unarchiving the portal to control its visibility.
- Modifying the homepage link or page title to reflect new URLs or branding changes.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to which the portal belongs (required). |
| Archived | Boolean flag indicating whether the portal is archived (not live) or active. |
| Color | Header color for 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 (e.g., "https://chatwoot.help/"). |
| Header Text | Text displayed in the header of the help center portal. |
| Homepage Link | URL linking to the main dashboard or homepage related to the portal. |
| Name | Name of the portal. |
| Slug | URL slug used to display the portal in links. |
| Page Title | Title of the portal page shown in browser tabs or search results. |
Output
The node outputs JSON data representing the updated portal information after the update operation completes successfully. This typically includes the current state of the portal with all the properties that were set or modified.
If the node supports binary data output, it is not indicated here; thus, the output is primarily JSON structured data reflecting the portal's updated configuration.
Dependencies
- Requires an API key credential for authenticating requests to the ChatWoot API.
- Needs the base URL of the ChatWoot instance configured in the credentials.
- Depends on the ChatWoot API being accessible and supporting the "Update New Portal To Account" endpoint.
Troubleshooting
- Invalid Account Id: If the provided account ID does not exist or is incorrect, the API will likely return an error. Verify the account ID before running the node.
- Malformed JSON in Config: The
configproperty expects valid JSON. Invalid JSON syntax will cause parsing errors. Ensure the JSON is well-formed. - Unauthorized Access: Missing or invalid API credentials will result in authentication errors. Confirm that the API key and base URL are correctly configured.
- Invalid Color Format: The
colorproperty should be a valid HEX color string. Incorrect formats may cause the API to reject the request. - Network Issues: Connectivity problems to the ChatWoot API endpoint can cause timeouts or failures. Check network access and API availability.
Links and References
- ChatWoot Official Documentation
- Help Center Portal Configuration Guide
- JSON Syntax Validator – Useful for validating the
configJSON input.