Skip to content

Commit 81c0e5a

Browse files
Update api.intercom.io.yaml
1 parent 9d3c3b7 commit 81c0e5a

File tree

1 file changed

+198
-0
lines changed

1 file changed

+198
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14845,6 +14845,179 @@ paths:
1484514845
message: Active subscription needed.
1484614846
schema:
1484714847
"$ref": "#/components/schemas/error"
14848+
"/tickets/{ticket_id}/change_type":
14849+
post:
14850+
summary: Change ticket type
14851+
parameters:
14852+
- name: Intercom-Version
14853+
in: header
14854+
schema:
14855+
"$ref": "#/components/schemas/intercom_version"
14856+
- name: ticket_id
14857+
in: path
14858+
required: true
14859+
description: The unique identifier for the ticket which is given by Intercom.
14860+
schema:
14861+
type: string
14862+
tags:
14863+
- Tickets
14864+
operationId: changeTicketType
14865+
description: You can change the type of a ticket. The new ticket type must
14866+
be in the same category as the current type. Attributes matching by name
14867+
and type are automatically transferred from the old type; values provided
14868+
in ticket_attributes override transferred values.
14869+
responses:
14870+
'200':
14871+
description: Successful response
14872+
content:
14873+
application/json:
14874+
examples:
14875+
Successful response:
14876+
value:
14877+
type: ticket
14878+
id: '494'
14879+
ticket_id: '53'
14880+
ticket_attributes:
14881+
_default_title_: example
14882+
_default_description_: having a problem
14883+
ticket_state: submitted
14884+
ticket_type:
14885+
type: ticket_type
14886+
id: '1234'
14887+
name: my-new-ticket-type
14888+
description: my ticket type description is awesome.
14889+
icon: "\U0001F981"
14890+
workspace_id: this_is_an_id664_that_should_be_at_least_
14891+
archived: false
14892+
created_at: 1719493065
14893+
updated_at: 1719493065
14894+
is_internal: false
14895+
ticket_type_attributes:
14896+
type: list
14897+
data: []
14898+
category: Back-office
14899+
contacts:
14900+
type: contact.list
14901+
contacts:
14902+
- type: contact
14903+
id: 667d61c88a68186f43bafe93
14904+
external_id: '71'
14905+
admin_assignee_id: '0'
14906+
team_assignee_id: '0'
14907+
created_at: 1719493065
14908+
updated_at: 1719493068
14909+
ticket_parts:
14910+
type: ticket_part.list
14911+
ticket_parts:
14912+
- type: ticket_part
14913+
id: '136'
14914+
part_type: ticket_state_updated_by_admin
14915+
ticket_state: submitted
14916+
previous_ticket_state: submitted
14917+
created_at: 1719493065
14918+
updated_at: 1719493065
14919+
author:
14920+
id: '991267920'
14921+
type: bot
14922+
name: Operator
14923+
email: operator+this_is_an_id664_that_should_be_at_least_@intercom.io
14924+
attachments: []
14925+
redacted: false
14926+
total_count: 1
14927+
open: true
14928+
linked_objects:
14929+
type: list
14930+
data: []
14931+
total_count: 0
14932+
has_more: false
14933+
category: Back-office
14934+
is_shared: false
14935+
ticket_state_internal_label: Submitted
14936+
ticket_state_external_label: Submitted
14937+
schema:
14938+
"$ref": "#/components/schemas/ticket"
14939+
'400':
14940+
description: Bad request
14941+
content:
14942+
application/json:
14943+
examples:
14944+
Missing ticket_type_id:
14945+
value:
14946+
type: error.list
14947+
request_id: a35b00e4-97b2-4b5d-a6f9-e82c4d8f7e12
14948+
errors:
14949+
- code: parameter_not_found
14950+
message: ticket_type_id is a required parameter
14951+
Missing ticket_state_id:
14952+
value:
14953+
type: error.list
14954+
request_id: b46c11f5-08c3-5c6e-b7a3-f93d5e8f9f23
14955+
errors:
14956+
- code: parameter_not_found
14957+
message: ticket_state_id is a required parameter
14958+
Same ticket type:
14959+
value:
14960+
type: error.list
14961+
request_id: f90a55j9-42g7-9g0i-f1e7-jd7h9i2j3j67
14962+
errors:
14963+
- code: parameter_invalid
14964+
message: Cannot change to the same ticket type
14965+
Ticket state not in new ticket type:
14966+
value:
14967+
type: error.list
14968+
request_id: g01b66k0-53h8-0h1j-g2f8-ke8i0j3k4k78
14969+
errors:
14970+
- code: parameter_invalid
14971+
message: Ticket custom state doesn't belong to the new ticket type
14972+
Unknown ticket attribute:
14973+
value:
14974+
type: error.list
14975+
request_id: h12c77l1-64i9-1i2k-h3g9-lf9j1k4l5l89
14976+
errors:
14977+
- code: parameter_invalid
14978+
message: 'Extra attributes provided that are not found on ticket type:
14979+
Priority'
14980+
schema:
14981+
"$ref": "#/components/schemas/error"
14982+
'401':
14983+
description: Unauthorized
14984+
content:
14985+
application/json:
14986+
examples:
14987+
Unauthorized:
14988+
value:
14989+
type: error.list
14990+
request_id: c57d22g6-19d4-6d7f-c8b4-ga4e6f9g0g34
14991+
errors:
14992+
- code: unauthorized
14993+
message: Access Token Invalid
14994+
schema:
14995+
"$ref": "#/components/schemas/error"
14996+
'404':
14997+
description: Ticket not found
14998+
content:
14999+
application/json:
15000+
examples:
15001+
Ticket not found:
15002+
value:
15003+
type: error.list
15004+
request_id: e79f44i8-31f6-8f9h-e0d6-ic6g8h1i2i56
15005+
errors:
15006+
- code: not_found
15007+
message: Resource Not Found
15008+
schema:
15009+
"$ref": "#/components/schemas/error"
15010+
requestBody:
15011+
content:
15012+
application/json:
15013+
schema:
15014+
"$ref": "#/components/schemas/change_ticket_type_request"
15015+
examples:
15016+
successful_response:
15017+
summary: Successful response
15018+
value:
15019+
ticket_type_id: '1234'
15020+
ticket_state_id: '5678'
1484815021
"/tickets/search":
1484915022
post:
1485015023
summary: Search tickets
@@ -17101,6 +17274,31 @@ components:
1710117274
type: integer
1710217275
description: "The Unix timestamp when the status reason was last updated"
1710317276
example: 1734537243
17277+
change_ticket_type_request:
17278+
title: Change Ticket Type Request
17279+
description: You can change the type of a Ticket
17280+
type: object
17281+
properties:
17282+
ticket_type_id:
17283+
type: string
17284+
description: The ID of the new ticket type. Must be in the same category
17285+
as the current type.
17286+
example: '1234'
17287+
ticket_state_id:
17288+
type: string
17289+
description: The ID of the ticket state for the new ticket type.
17290+
example: '5678'
17291+
ticket_attributes:
17292+
type: object
17293+
description: The attributes to set on the ticket for the new type. Attributes
17294+
matching by name and type are transferred automatically from the old type;
17295+
values provided here override the transferred values.
17296+
example:
17297+
_default_title_: example
17298+
_default_description_: having a problem
17299+
required:
17300+
- ticket_type_id
17301+
- ticket_state_id
1710417302
close_conversation_request:
1710517303
title: Close Conversation Request
1710617304
type: object

0 commit comments

Comments
 (0)