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 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 reporting and analytics by capturing unique account attributes.
For example, you might add a "Preferred Language" attribute with a list of possible values or a "Customer Tier" attribute with numeric ranking.
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 of the custom attribute shown in the UI. |
| 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 description explaining the purpose or usage of the attribute. |
| Attribute Key | A unique key identifier for the attribute used internally. |
| Attribute Values | JSON array defining possible values for the attribute (useful for list types). |
| Attribute Model | The model type of the attribute: conversation attribute (0) or contact attribute (1). |
Output
The node outputs JSON data representing the newly created custom attribute object as returned by the ChatWoot API. This typically includes all attribute details such as its ID, key, display name, type, description, and any predefined values.
If the API supports it, binary data output is not expected for this operation.
Dependencies
- Requires an active connection to the ChatWoot API.
- Needs an API authentication token configured in the node credentials.
- The base URL for the ChatWoot instance must be set in the credentials.
Troubleshooting
- Invalid Account Id: Ensure the provided account ID exists and is numeric.
- Duplicate Attribute Key: The attribute key must be unique; conflicts will cause errors.
- Invalid Attribute Values JSON: The attribute values must be valid JSON; malformed input will cause parsing errors.
- Authentication Errors: Verify that the API token is correct and has sufficient permissions.
- Unsupported Attribute Display Type: Use only the supported numeric codes for attribute types.
Links and References
- ChatWoot API Documentation
- Custom Attributes Guide on ChatWoot (if available)