Chat icon

Chat

Interact with the Chat API

Actions253

Custom Attribute → Create Custom Attribute

AI-generated

Summary

Creates a new custom attribute definition for contacts or conversations within a specified account.

Inputs

  • accountId (required) — Select or enter the account ID where the custom attribute will be created.
  • attributeModel (required) — The target model for the attribute ('contact_attribute' or 'conversation_attribute').
  • attributeDisplayName (required) — Display name of the custom attribute.
  • attributeType — Data type for the attribute, such as text, number, list, checkbox, date, currency, link, or percent.
  • additionalFields — Optional settings including custom attribute key, description, list options as JSON, or regex pattern validation for text types.

Output shape

a single record

Returns the created custom attribute object including its ID, key, display name, model, type, and configuration options.

Examples

Example 1: Create a list attribute for contacts to track loyalty tier

Select Account, set Attribute Model to 'Contact Attribute', Attribute Display Name to 'Loyalty Tier', Attribute Type to 'List', and set List Values to ["Bronze", "Silver", "Gold"].

Example 2: Create a text attribute for conversations with regex validation

Select Account, set Attribute Model to 'Conversation Attribute', Attribute Display Name to 'Order ID', Attribute Type to 'Text', and supply Regex Pattern in Additional Fields.

Links

Discussion