Fale JáInstall

Summary

Create a custom attribute (contact or conversation field) in Fale Ja/Chatwoot

Inputs

• apiType — Select which API to use: Application API (agents/admins managing conversations, contacts, messages, teams, reports, account settings); Client API (end-users/customers via web widgets, mobile apps); Platform API (system administrators managing multiple accounts, users, platform configurations). Default: Application API.
• attributeModel (required) — Type of custom attribute to create: Contact Attribute (field for contacts) or Conversation Attribute (field for conversations). Default: Contact Attribute.
• attribute_display_name (required) — Display name for the attribute as shown in the UI. Default: empty. Example: 'Customer ID'.
• attribute_key (required) — Unique key for the attribute used in the API. Default: empty. Must be unique within the account. Example: 'customer_id'.
• attribute_display_type (required) — Input field type for the attribute value: Text (single line), Number, Currency, Percent, Link (URL), Date (picker), List (single select dropdown), or Checkbox (multiple select). Default: Text.
• additionalFields — Optional collection of additional attribute properties. Sub-fields: attribute_description (text), default_value (text), attribute_values (comma-separated list of options, required for List or Checkbox display types).

Output shape

The operation returns the created custom attribute object from the Chatwoot API, containing at minimum the attribute key, display name, display type, and model type. Exact return shape depends on the selected API type.

Successful creation returns the attribute record; errors may occur if the attribute key already exists or required fields are invalid for the chosen display type.

Examples

Example 1: Create a contact custom attribute for customer tier

apiType: Application API; attributeModel: contact_attribute; attribute_display_name: 'Customer Tier'; attribute_key: 'customer_tier'; attribute_display_type: 'List'; additionalFields.attribute_values: 'Basic,Premium,Enterprise'

Links

• n8n community nodes installation guide