Skip to content

Add change_type ticket endpoint to Unstable API spec #393

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
junaid-zaidi-intercom merged 1 commit into from
Mar 6, 2026
Merged

Add change_type ticket endpoint to Unstable API spec #393

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
198 changes: 198 additions & 0 deletions descriptions/0/api.intercom.io.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14845,6 +14845,179 @@ paths:
message: Active subscription needed.
schema:
"$ref": "#/components/schemas/error"
"/tickets/{ticket_id}/change_type":
post:
summary: Change ticket type
parameters:
- name: Intercom-Version
in: header
schema:
"$ref": "#/components/schemas/intercom_version"
- name: ticket_id
in: path
required: true
description: The unique identifier for the ticket which is given by Intercom.
schema:
type: string
tags:
- Tickets
operationId: changeTicketType
description: You can change the type of a ticket. The new ticket type must
be in the same category as the current type. Attributes matching by name
and type are automatically transferred from the old type; values provided
in ticket_attributes override transferred values.
responses:
'200':
description: Successful response
content:
application/json:
examples:
Successful response:
value:
type: ticket
id: '494'
ticket_id: '53'
ticket_attributes:
_default_title_: example
_default_description_: having a problem
ticket_state: submitted
ticket_type:
type: ticket_type
id: '1234'
name: my-new-ticket-type
description: my ticket type description is awesome.
icon: "\U0001F981"
workspace_id: this_is_an_id664_that_should_be_at_least_
archived: false
created_at: 1719493065
updated_at: 1719493065
is_internal: false
ticket_type_attributes:
type: list
data: []
category: Back-office
contacts:
type: contact.list
contacts:
- type: contact
id: 667d61c88a68186f43bafe93
external_id: '71'
admin_assignee_id: '0'
team_assignee_id: '0'
created_at: 1719493065
updated_at: 1719493068
ticket_parts:
type: ticket_part.list
ticket_parts:
- type: ticket_part
id: '136'
part_type: ticket_state_updated_by_admin
ticket_state: submitted
previous_ticket_state: submitted
created_at: 1719493065
updated_at: 1719493065
author:
id: '991267920'
type: bot
name: Operator
email: operator+this_is_an_id664_that_should_be_at_least_@intercom.io
attachments: []
redacted: false
total_count: 1
open: true
linked_objects:
type: list
data: []
total_count: 0
has_more: false
category: Back-office
is_shared: false
ticket_state_internal_label: Submitted
ticket_state_external_label: Submitted
schema:
"$ref": "#/components/schemas/ticket"
'400':
description: Bad request
content:
application/json:
examples:
Missing ticket_type_id:
value:
type: error.list
request_id: a35b00e4-97b2-4b5d-a6f9-e82c4d8f7e12
errors:
- code: parameter_not_found
message: ticket_type_id is a required parameter
Missing ticket_state_id:
value:
type: error.list
request_id: b46c11f5-08c3-5c6e-b7a3-f93d5e8f9f23
errors:
- code: parameter_not_found
message: ticket_state_id is a required parameter
Same ticket type:
value:
type: error.list
request_id: f90a55j9-42g7-9g0i-f1e7-jd7h9i2j3j67
errors:
- code: parameter_invalid
message: Cannot change to the same ticket type
Ticket state not in new ticket type:
value:
type: error.list
request_id: g01b66k0-53h8-0h1j-g2f8-ke8i0j3k4k78
errors:
- code: parameter_invalid
message: Ticket custom state doesn't belong to the new ticket type
Unknown ticket attribute:
value:
type: error.list
request_id: h12c77l1-64i9-1i2k-h3g9-lf9j1k4l5l89
errors:
- code: parameter_invalid
message: 'Extra attributes provided that are not found on ticket type:
Priority'
schema:
"$ref": "#/components/schemas/error"
'401':
description: Unauthorized
content:
application/json:
examples:
Unauthorized:
value:
type: error.list
request_id: c57d22g6-19d4-6d7f-c8b4-ga4e6f9g0g34
errors:
- code: unauthorized
message: Access Token Invalid
schema:
"$ref": "#/components/schemas/error"
'404':
description: Ticket not found
content:
application/json:
examples:
Ticket not found:
value:
type: error.list
request_id: e79f44i8-31f6-8f9h-e0d6-ic6g8h1i2i56
errors:
- code: not_found
message: Resource Not Found
schema:
"$ref": "#/components/schemas/error"
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/change_ticket_type_request"
examples:
successful_response:
summary: Successful response
value:
ticket_type_id: '1234'
ticket_state_id: '5678'
"/tickets/search":
post:
summary: Search tickets
Expand Down Expand Up @@ -17101,6 +17274,31 @@ components:
type: integer
description: "The Unix timestamp when the status reason was last updated"
example: 1734537243
change_ticket_type_request:
title: Change Ticket Type Request
description: You can change the type of a Ticket
type: object
properties:
ticket_type_id:
type: string
description: The ID of the new ticket type. Must be in the same category
as the current type.
example: '1234'
ticket_state_id:
type: string
description: The ID of the ticket state for the new ticket type.
example: '5678'
ticket_attributes:
type: object
description: The attributes to set on the ticket for the new type. Attributes
matching by name and type are transferred automatically from the old type;
values provided here override the transferred values.
example:
_default_title_: example
_default_description_: having a problem
required:
- ticket_type_id
- ticket_state_id
close_conversation_request:
title: Close Conversation Request
type: object
Expand Down