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 operation allows you to add a new custom attribute to an account within the ChatWoot platform. Custom attributes are useful for extending account data with additional metadata tailored to your business needs, such as tracking specific customer details or preferences.
Typical use cases include:
- Adding personalized fields to accounts for segmentation or targeted communication.
- Storing extra information like loyalty status, subscription type, or custom tags.
- Enhancing CRM data by integrating external system attributes.
For example, you might add a "Preferred Language" attribute with a list of language options or a "Customer Tier" attribute with numeric values representing different levels.
Properties
| Name | Meaning |
|---|---|
| Account Id | The numeric ID of the account to which the custom attribute will be added. |
| Attribute Display Name | The display name shown for the custom attribute in the UI or reports. |
| Attribute Display Type | The type of the attribute's value. Options: text (0), number (1), currency (2), percent (3), link (4), date (5), list (6), checkbox (7). |
| Attribute Description | A textual description explaining the purpose or usage of the attribute. |
| Attribute Key | A unique key identifier for the attribute, used internally to reference it. |
| Attribute Values | JSON array defining possible values for the attribute (useful for list types or predefined options). |
| Attribute Model | Defines the model type of the attribute: conversation attribute (0) or contact attribute (1). |
Output
The node outputs JSON data representing the response from the ChatWoot API after adding the custom attribute. This typically includes details of the newly created attribute such as its ID, key, display name, type, and other metadata confirming successful creation.
No binary data output is involved.
Dependencies
- Requires an active connection to the ChatWoot API.
- Needs an API authentication token configured in n8n credentials to authorize requests.
- The base URL for the ChatWoot instance must be set in the credentials.
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.
- Duplicate Attribute Key: Attempting to add an attribute with a key that already exists may cause conflicts. Use unique keys.
- Malformed JSON in Attribute Values: Ensure the JSON input for attribute values is correctly formatted; otherwise, parsing errors may occur.
- Authentication Errors: Check that the API key/token is valid and has sufficient permissions to modify account attributes.
- Unsupported Attribute Display Type: Use only the supported numeric codes for attribute display types as specified.
Links and References
- ChatWoot API Documentation
- Custom Attributes Guide - ChatWoot
- n8n Documentation on HTTP Request Nodes (for understanding API calls)