POST/ticket_types

Create a ticket type

Creates a new ticket type with its name, description, category, icon, and internal-use setting. Supply name; category accepts Customer, Back-office, or Tracker, and omitted icon and is_internal values default to 🎟️ and false. The created ticket type includes the default _default_title_ and _default_description_ attributes.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 5 body fields
Intercom-Versionstringoptional
The API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Ticket type details to create. name is required; the API adds the default _default_title_ and _default_description_ attributes.

namestringrequired
The name of the ticket type.
descriptionstringoptional
The description of the ticket type.
categorystringoptional
Category of the Ticket Type.
Allowed:CustomerBack-officeTracker
iconstringoptional
The icon of the ticket type.
Default:🎟️
is_internalbooleanoptional
Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.
Default:false

2 status codes
200Returns the created ticket type, including its identifier, category, attributes, states, archive status, and timestamps.
typestringoptional
String representing the object's type. Always has the value `ticket_type`.
idstringoptional
The id representing the ticket type.
categorystringoptional
Category of the Ticket Type.
Allowed:CustomerBack-officeTracker
namestringoptional
The name of the ticket type
descriptionstringoptional
The description of the ticket type
iconstringoptional
The icon of the ticket type
workspace_idstringoptional
The id of the workspace that the ticket type belongs to.
ticket_type_attributesobjectoptional
A list of attributes associated with a given ticket type.
ticket_statesobjectoptional
A list of ticket states associated with a given ticket type.
archivedbooleanoptional
Whether the ticket type is archived or not.
created_atintegeroptional
The date and time the ticket type was created.
updated_atintegeroptional
The date and time the ticket type was last updated.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. name is required, and category must be Customer, Back-office, or Tracker when provided.