Custom Attributes

Custom Attributes are the additional fields you can add to your contacts in Chatbase. Each chatbot has its own custom attribute schema that defines what additional data can be stored for contacts.

Schema Management

Field Lifecycle

Custom attributes, once created, cannot be deleted from the schema
Fields can be archived to prevent new usage while preserving historical data
When a field is archived:
- New contacts cannot be created with this field
- Existing contacts cannot update this field
- The field can only be set to null
- Existing values are preserved and still readable

Available Endpoints

The Custom Attributes API provides the following endpoints:

List Custom Attributes: Retrieve all custom attributes for a chatbot
Create Custom Attribute: Add a new custom attribute to a chatbot

Available Types

text

string

For storing text values

number

For storing numeric values

boolean

For storing true/false values

Data of type boolean passed to the contacts API will be coerced to a boolean.For example, a string of value “true” will be converted to a true. And a string of value “false” will be converted to a false.Also, a number of value 0 will be converted to a false. And a number of value 1 will be converted to a true.

date

string

For storing dates in ISO 8601 format

Data of type date passed to the contacts API will be coerced to a date.Supporting formats exactly supported by Javascript Date.

Custom Attribute Object

name

string

required

The unique identifier for the custom attribute

type

string

required

The type of the attribute. One of: text, number, boolean, date

label

string

required

The display label for the attribute

description

string

Description of the attribute

archived

boolean

Whether the attribute is archived. If true, the attribute cannot be used for new or updated values

Using Custom Attributes

Once you’ve created custom attributes, you can:

Add values for these attributes when creating contacts
Update values through the update contact endpoint
View values when listing contacts or getting a single contact

Example

{
  "custom_attributes": {
    "company": "Acme Inc",        // text type
    "age": 25,                    // number type
    "is_active": true,            // boolean type
    "join_date": "2023-01-15",    // date type
    "unknown_field": "value"      // will be stripped out
  }
}

Field Handling