Chatwoot · Schema

Custom Attribute

Chatwoot Custom Attribute schema

Customer SupportMessagingLive ChatOmni-channelConversationsContactsAgentsOpen Source

Properties

Name Type Description
id integer Identifier
attribute_display_name string Attribute display name
attribute_display_type string Attribute display type (text, number, currency, percent, link, date, list, checkbox)
attribute_description string Attribute description
attribute_key string Attribute unique key value
regex_pattern string Regex pattern
regex_cue string Regex cue
attribute_values string Attribute values
attribute_model string Attribute type(conversation_attribute/contact_attribute)
default_value string Attribute default value
created_at string The date and time when the custom attribute was created
updated_at string The date and time when the custom attribute was updated
View JSON Schema on GitHub

JSON Schema

custom_attribute.json Raw ↑ 
{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identifier"
    },
    "attribute_display_name": {
      "type": "string",
      "description": "Attribute display name"
    },
    "attribute_display_type": {
      "type": "string",
      "description": "Attribute display type (text, number, currency, percent, link, date, list, checkbox)"
    },
    "attribute_description": {
      "type": "string",
      "description": "Attribute description"
    },
    "attribute_key": {
      "type": "string",
      "description": "Attribute unique key value"
    },
    "regex_pattern": {
      "type": "string",
      "description": "Regex pattern"
    },
    "regex_cue": {
      "type": "string",
      "description": "Regex cue"
    },
    "attribute_values": {
      "type": "string",
      "description": "Attribute values"
    },
    "attribute_model": {
      "type": "string",
      "description": "Attribute type(conversation_attribute/contact_attribute)"
    },
    "default_value": {
      "type": "string",
      "description": "Attribute default value"
    },
    "created_at": {
      "type": "string",
      "description": "The date and time when the custom attribute was created"
    },
    "updated_at": {
      "type": "string",
      "description": "The date and time when the custom attribute was updated"
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/chatwoot/main/json-schema/custom_attribute.json",
  "title": "Custom Attribute",
  "description": "Chatwoot Custom Attribute schema"
}