ChatWoot Application icon

ChatWoot Application

Interact with ChatWoot Application APIs

Actions112

Custom Attribute → Update Custom Attribute in Account

AI-generated

Summary

Update an existing custom attribute for a specific account in ChatWoot by specifying the account ID and the custom attribute's ID or name, optionally modifying its description, display name, display type, key, model, values, or validation regex.

Inputs

  • Account ID (required) — The numeric ID of the ChatWoot account where the custom attribute exists.
  • Name or ID (required) — The identifier or name of the custom attribute to update, selectable from existing custom attributes of the specified account.
  • Additional Options — Optional fields to update for the custom attribute, including attribute description, display name, display type (e.g., text, number, currency, etc.), unique key, attribute model (conversation or contact attribute), attribute values in JSON format, regex validation pattern, and cue message for invalid input.

Output shape

a JSON object representing the updated custom attribute's data as returned by ChatWoot API

The operation returns the updated custom attribute details in the response body. Optional fields in Additional Options are only included in the request body if provided. The operation requires an existing custom attribute ID or name to update and the numeric account ID.

Examples

Example 1: Update the display name of a custom attribute for account ID 1

Set Account ID to 1, select the custom attribute by its ID or name from the dropdown loaded from the account, set Additional Options -> Attribute Display Name with the new display name string.

Links

Discussion