ChatWoot icon

ChatWoot

Interact with ChatWoot API

Actions113

Custom Attributes → Update Custom Attribute In Account

AI-generated

Overview

This node interacts with the ChatWoot API to update a custom attribute within a specified account. Custom attributes are metadata fields that can be attached to accounts, contacts, or conversations to store additional information beyond default properties.

Typical use cases include:

  • Modifying the display name or description of an existing custom attribute.
  • Changing the data type or model (e.g., from contact attribute to conversation attribute).
  • Updating the list of possible values for attributes that support multiple options.

For example, you might use this node to rename a "Customer Tier" attribute to "Loyalty Level" or to add new selectable values to a dropdown attribute.

Properties

Name Meaning
Account Id The numeric ID of the account where the custom attribute exists.
Id The unique numeric ID of the custom attribute to update.
Attribute Display Name The new display name for the custom attribute.
Attribute Display Type The data type of the attribute's display:
0 - text
1 - number
2 - currency
3 - percent
4 - link
5 - date
6 - list
7 - checkbox
Attribute Description A textual description explaining the purpose or details of the attribute.
Attribute Key The unique key identifier for the attribute (used internally).
Attribute Values JSON array representing the possible values for the attribute (useful for list-type attributes).
Attribute Model The model type indicating the scope of the attribute:
0 - conversation attribute
1 - contact attribute

Output

The node outputs JSON data representing the updated custom attribute as returned by the ChatWoot API. This typically includes all attribute details such as its ID, display name, type, description, key, values, and model.

If the API supports binary data in responses (not indicated here), it would be summarized accordingly, but this node primarily deals with JSON metadata.

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 or Attribute ID: If the provided account or attribute ID does not exist, the API will return an error. Verify IDs before running the node.
  • Incorrect Attribute Values Format: The attribute_values property expects valid JSON. Malformed JSON will cause parsing errors.
  • Insufficient Permissions: Ensure the API token has permissions to update custom attributes.
  • Unsupported Attribute Display Type or Model: Using invalid numeric codes for display type or model may result in API rejection.
  • Network Issues: Connectivity problems with the ChatWoot server will cause request failures.

Links and References

Discussion