Update a ticket type

Home

REST API Reference

Ticket Types

You can update a ticket type.

📘 Updating a ticket type.
For the icon propery, use an emoji from Twemoji Cheatsheet

SecurityHTTP: bearerAuth

Request

path Parameters

required

string

The unique identifier for the ticket type which is given by Intercom.

header Parameters

Intercom-Version

string (intercom_version)

Default: 2.11

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"

Example: 2.11

Request Body schema: application/json

name	string The name of the ticket type.
description	string The description of the ticket type.
category	string Category of the Ticket Type. Enum: "Customer" "Back-office" "Tracker"
icon	string Default: "🎟️" The icon of the ticket type.
archived	boolean The archived status of the ticket type.
is_internal	boolean Default: false 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.

put

/ticket_types/{id}

Request samples
Payload
curl
Node.js
Ruby
PHP
Python
Java
Go
C#
R
5 more
application/json
Ticket type updated
{
"name": "Bug Report 2"
}

Responses

200

Ticket type updated

Response Schema: application/json

type	string String representing the object's type. Always has the value `ticket_type`.
id	string The id representing the ticket type.
category	string Category of the Ticket Type. Enum: "Customer" "Back-office" "Tracker"
name	string The name of the ticket type
description	string The description of the ticket type
icon	string The icon of the ticket type
workspace_id	string The id of the workspace that the ticket type belongs to.
	object (Ticket Type Attributes) A list of attributes associated with a given ticket type.
archived	boolean Whether the ticket type is archived or not.
created_at	integer <timestamp> The date and time the ticket type was created.
updated_at	integer <timestamp> The date and time the ticket type was last updated.

401

Unauthorized

Response samples
200
401
application/json
Ticket type updated
{
"type": "ticket_type",
"id": "300",
"name": "Bug Report 2",
"description": "Bug Report Template",
"icon": "🎟️",
"workspace_id": "this_is_an_id609_that_should_be_at_least_",
"archived": false,
"created_at": 1715078027,
"updated_at": 1715078027,
"is_internal": false,
"ticket_type_attributes": {
"type": "list",
"data": [
{
"type": "ticket_type_attribute",
"id": "824",
"workspace_id": "this_is_an_id609_that_should_be_at_least_",
"name": "_default_title_",
"description": "",
"data_type": "string",
"input_options": {
"multiline": false
},
"order": 0,
"required_to_create": false,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": true,
"default": true,
"ticket_type_id": 300,
"archived": false,
"created_at": 1715078027,
"updated_at": 1715078027
},
{
"type": "ticket_type_attribute",
"id": "826",
"workspace_id": "this_is_an_id609_that_should_be_at_least_",
"name": "name",
"description": "description",
"data_type": "string",
"input_options": null,
"order": 0,
"required_to_create": false,
"required_to_create_for_contacts": false,
"visible_on_create": false,
"visible_to_contacts": false,
"default": false,
"ticket_type_id": 300,
"archived": false,
"created_at": 1715078027,
"updated_at": 1715078027
},
{
"type": "ticket_type_attribute",
"id": "825",
"workspace_id": "this_is_an_id609_that_should_be_at_least_",
"name": "_default_description_",
"description": "",
"data_type": "string",
"input_options": {
"multiline": true
},
"order": 1,
"required_to_create": false,
"required_to_create_for_contacts": false,
"visible_on_create": true,
"visible_to_contacts": true,
"default": true,
"ticket_type_id": 300,
"archived": false,
"created_at": 1715078027,
"updated_at": 1715078027
}
]
},
"category": "Customer"
}