Create Conversation Attribute Request (List)

Home/

REST API Reference

namestringrequired

Name of the attribute.

Example:"api_test_attr"

descriptionstring

Readable description of the attribute.

Example:"Created via API test"

data_typestringrequired

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

Value:"list"

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:

[]

optionsArray of objects, >= 2 items(Create Conversation Attribute Option Request)required

Initial options for this list attribute. Each option must have a label. A list attribute needs at least 2 options.

{
  "name": "api_test_attr",
  "description": "Created via API test",
  "data_type": "list",
  "required": false,
  "visible_to_team_ids": [],
  "options": [
    { … },
    { … }
  ]
}