Conversation Attribute Base

Home/

REST API Reference

typestring

Value is conversation_attribute.

Value:"conversation_attribute"

Example:"conversation_attribute"

idinteger

The unique identifier for the conversation attribute.

Example:8

namestring

Name of the attribute.

Example:"api_test_attr"

descriptionstring

Readable description of the attribute.

Example:"Created via API test"

data_typestring

The data type of the attribute. Allowed types: string, integer, list, decimal, boolean, datetime, relationship, files.

Enum:"string""integer""list""decimal""boolean""datetime""relationship""files"

Example:"string"

requiredboolean

Whether this attribute is required.

Example:false

visible_to_team_idsArray of strings

Team IDs that can see this attribute. Empty array means all teams.

Example:

[]

archivedboolean

Whether this attribute is archived.

Example:false

created_atinteger, (date-time)

The time the attribute was created as a UTC Unix timestamp.

Example:1778239701

updated_atinteger, (date-time)

The time the attribute was last updated as a UTC Unix timestamp.

Example:1778239701

admin_idstring

ID of the admin who created the attribute.

Example:"16"

{
  "type": "conversation_attribute",
  "id": 8,
  "name": "api_test_attr",
  "description": "Created via API test",
  "data_type": "string",
  "required": false,
  "visible_to_team_ids": [],
  "archived": false,
  "created_at": 1778239701,
  "updated_at": 1778239701,
  "admin_id": "16"
}