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

GET/v2/conversation_attributes

Get a conversation custom attribute by ID

GET/v2/conversation_attributes/{id}

ModelsExpand Collapse

ConversationAttribute object { id, archived, dataType, 8 more }

id: string

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

archived: boolean

Whether this definition has been archived.

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

Storage-level data type used for validation and search.

One of the following:

"string"

"number"

"boolean"

"date"

"array"

"object"

fieldSubType: "text" or "number" or "select" or 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: optional string

ISO timestamp when the attribute was created.

options: optional array of ConversationAttributeOption { label, id }

Allowed values for select and multi-select attributes.

label: string

Option display label

id: optional string

Option unique identifier when stored for this option.

required: optional boolean

Whether teammates must set a value before closing a conversation from the Inbox. Closes via the API, workflows, and Fibi are not blocked.

updatedAt: optional string

ISO timestamp when the attribute was last updated.

ConversationAttributeOption object { label, id }

label: string

Option display label

id: optional string

Option unique identifier when stored for this option.

ConversationAttributeListResponse object { data, nextCursor, object }

data: array of ConversationAttribute { id, archived, dataType, 8 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" or "number" or "boolean" or 3 more

Storage-level data type used for validation and search.

One of the following:

"string"

"number"

"boolean"

"date"

"array"

"object"

fieldSubType: "text" or "number" or "select" or 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: optional string

ISO timestamp when the attribute was created.

options: optional array of ConversationAttributeOption { label, id }

Allowed values for select and multi-select attributes.

label: string

Option display label

id: optional string

Option unique identifier when stored for this option.

required: optional boolean

Whether teammates must set a value before closing a conversation from the Inbox. Closes via the API, workflows, and Fibi are not blocked.

updatedAt: optional string

ISO timestamp when the attribute was last updated.

nextCursor: string

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

object: "list"

Object type identifier