Conversation Attributes

Conversation custom attribute definitions configured in your Featurebase organization. Use these definitions to map ID-keyed conversation custom attributes to human-readable names and value types.

List conversation custom attributes

client.conversationAttributes.list(?, ?): ConversationAttributeListResponse { data, nextCursor, object }

GET/v2/conversation_attributes

Get a conversation custom attribute by ID

client.conversationAttributes.retrieve(, ?, ?): ConversationAttribute { id, archived, dataType, 7 more }

GET/v2/conversation_attributes/{id}

ModelsExpand Collapse

ConversationAttribute { id, archived, dataType, 7 more }

id: string

Stable machine identifier used as the key in conversation.customAttributes.

archived: boolean

Whether this definition has been archived.

dataType: "string" | "number" | "boolean" | 3 more

Storage-level data type used for validation and search.

One of the following:

"string"

"number"

"boolean"

"date"

"array"

"object"

fieldSubType: "text" | "number" | "select" | 3 more

Conversation field subtype that controls the expected value shape.

One of the following:

"text"

"number"

"select"

"multi-select"

"checkbox"

"date"

identifier: string

Stable internal identifier for the attribute definition.

name: string

Human-readable attribute name shown in Featurebase.

object: "conversation_attribute"

Object type identifier

createdAt?: string

ISO timestamp when the attribute was created.

options?: Array<ConversationAttributeOption { label, id } >

Allowed values for select and multi-select attributes.

label: string

Option display label

id?: string

Option unique identifier when stored for this option.

updatedAt?: string

ISO timestamp when the attribute was last updated.

ConversationAttributeOption { label, id }

label: string

Option display label

id?: string

Option unique identifier when stored for this option.

ConversationAttributeListResponse { data, nextCursor, object }

data: Array<ConversationAttribute { id, archived, dataType, 7 more } >

Array of conversation custom attribute definitions.

id: string

Stable machine identifier used as the key in conversation.customAttributes.

archived: boolean

Whether this definition has been archived.

dataType: "string" | "number" | "boolean" | 3 more

Storage-level data type used for validation and search.

One of the following:

"string"

"number"

"boolean"

"date"

"array"

"object"

fieldSubType: "text" | "number" | "select" | 3 more

Conversation field subtype that controls the expected value shape.

One of the following:

"text"

"number"

"select"

"multi-select"

"checkbox"

"date"

identifier: string

Stable internal identifier for the attribute definition.

name: string

Human-readable attribute name shown in Featurebase.

object: "conversation_attribute"

Object type identifier

createdAt?: string

ISO timestamp when the attribute was created.

options?: Array<ConversationAttributeOption { label, id } >

Allowed values for select and multi-select attributes.

label: string

Option display label

id?: string

Option unique identifier when stored for this option.

updatedAt?: string

ISO timestamp when the attribute was last updated.

nextCursor: string | null

Cursor for fetching the next page. Always null; all definitions are returned at once.

object: "list"

Object type identifier