Chatwoot icon

Chatwoot

Interact with Chatwoot API to manage conversations, messages, contacts, and more

Actions206

Custom Attribute → Create

AI-generated

Summary

Create a new custom attribute in Chatwoot for either contacts or conversations, defining its display name, unique key, model, data type, and optional properties like description, default value, and list of allowed values.

Inputs

  • Attribute Display Name (required) — Display name of the custom attribute shown in the Chatwoot UI.
  • Attribute Key (required) — Unique snake_case key for the custom attribute, without spaces.
  • Attribute Model (required) — Specifies whether the attribute applies to contacts or conversations.
  • Attribute Type (required) — Defines the data type of the attribute, such as text, number, currency, percent, link, date, list, or checkbox.
  • Additional Fields — Optional additional settings including description (string), default value (string), and, if type is 'List', a comma-separated list of allowed values.

Output shape

a single record representing the newly created custom attribute

The output contains the details of the created attribute including its key, display name, type, model, and any optional properties successfully set. Errors are thrown if required inputs are missing or invalid.

Links

Discussion