API ReferenceBuilding AppsInstalling IntercomAPI & Webhook ReferenceCanvas Kit Reference
DocsApp StoreCommunityBlogYour Apps

The Ticket Type model

🚧

Warning

Deletion of ticket types is not possible as existing tickets might still use the type, so we allow for soft deletion/archiving of types by setting the "archived" property.

Tickets are how you can capture complex requests, allowing you to collaborate and keep track of progress until a resolution is reached.

Each ticket is of a particular Ticket Type. Each ticket type defines names and properties of the fields presented to the teammate or contact when creating the ticket via Inbox and/or Messenger. When creating the ticket, the ticket type needs to be specified. Ticket types can be listed, created, retrieved and updated through the Ticket Types API.

Object Models

Ticket Type

FieldTypeDescription
typestringString representing the object's type. Always has the value ticket_type.
idstringThe id representing the ticket type.
namestringThe name of the ticket type
descriptionstringThe description of the ticket type
iconstringThe icon of the ticket type
workspace_idstringThe id of the workspace that the ticket type belongs to.
ticket_type_attributesobjectA list of attributes associated with a given ticket type.
archivedbooleanWhether the ticket type is archived or not.
created_atintegerThe date and time the ticket type was created.
updated_atintegerThe date and time the ticket type was last updated.

Ticket Type Attribute List

FieldTypeDescription
typestringString representing the object's type. Always has the value ticket_type_attributes.list.
ticket_type_attributesarrayA list of ticket type attributes associated with a given ticket type.