Create Ticket Type Attribute Request Payload

Home/

REST API Reference

You can create a Ticket Type Attribute

namestringrequired

The name of the ticket type attribute

Example:"Bug Priority"

descriptionstringrequired

The description of the attribute presented to the teammate or contact

Example:"Priority level of the bug"

data_typestringrequired

The data type of the attribute

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

Example:"string"

required_to_createboolean

Whether the attribute is required to be filled in when teammates are creating the ticket in Inbox.

Default:false

Example:false

required_to_create_for_contactsboolean

Whether the attribute is required to be filled in when contacts are creating the ticket in Messenger.

Default:false

Example:false

visible_on_createboolean

Whether the attribute is visible to teammates when creating a ticket in Inbox.

Default:true

Example:true

visible_to_contactsboolean

Whether the attribute is visible to contacts when creating a ticket in Messenger.

Default:true

Example:true

multilineboolean

Whether the attribute allows multiple lines of text (only applicable to string attributes)

Example:false

list_itemsstring

A comma delimited list of items for the attribute value (only applicable to list attributes)

Example:"Low Priority,Medium Priority,High Priority"

allow_multiple_valuesboolean

Whether the attribute allows multiple files to be attached to it (only applicable to file attributes)

Example:false

{
  "name": "Bug Priority",
  "description": "Priority level of the bug",
  "data_type": "string",
  "required_to_create": false,
  "required_to_create_for_contacts": false,
  "visible_on_create": true,
  "visible_to_contacts": true,
  "multiline": false,
  "list_items": "Low Priority,Medium Priority,High Priority",
  "allow_multiple_values": false
}