Skip to content

Commit 79d65c9

Browse files
junaid-zaidi-intercomjunaid-zaidi-intercom
authored
Update api.intercom.io.yaml (#393)
1 parent 34cc619 commit 79d65c9

1 file changed

Lines changed: 198 additions & 0 deletions

File tree

‎descriptions/0/api.intercom.io.yaml‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14940,6 +14940,179 @@ paths:
1494014940
message: Active subscription needed.
1494114941
schema:
1494214942
"$ref": "#/components/schemas/error"
14943+
"/tickets/{ticket_id}/change_type":
14944+
post:
14945+
summary: Change ticket type
14946+
parameters:
14947+
- name: Intercom-Version
14948+
in: header
14949+
schema:
14950+
"$ref": "#/components/schemas/intercom_version"
14951+
- name: ticket_id
14952+
in: path
14953+
required: true
14954+
description: The unique identifier for the ticket which is given by Intercom.
14955+
schema:
14956+
type: string
14957+
tags:
14958+
- Tickets
14959+
operationId: changeTicketType
14960+
description: You can change the type of a ticket. The new ticket type must
14961+
be in the same category as the current type. Attributes matching by name
14962+
and type are automatically transferred from the old type; values provided
14963+
in ticket_attributes override transferred values.
14964+
responses:
14965+
'200':
14966+
description: Successful response
14967+
content:
14968+
application/json:
14969+
examples:
14970+
Successful response:
14971+
value:
14972+
type: ticket
14973+
id: '494'
14974+
ticket_id: '53'
14975+
ticket_attributes:
14976+
_default_title_: example
14977+
_default_description_: having a problem
14978+
ticket_state: submitted
14979+
ticket_type:
14980+
type: ticket_type
14981+
id: '1234'
14982+
name: my-new-ticket-type
14983+
description: my ticket type description is awesome.
14984+
icon: "\U0001F981"
14985+
workspace_id: this_is_an_id664_that_should_be_at_least_
14986+
archived: false
14987+
created_at: 1719493065
14988+
updated_at: 1719493065
14989+
is_internal: false
14990+
ticket_type_attributes:
14991+
type: list
14992+
data: []
14993+
category: Back-office
14994+
contacts:
14995+
type: contact.list
14996+
contacts:
14997+
- type: contact
14998+
id: 667d61c88a68186f43bafe93
14999+
external_id: '71'
15000+
admin_assignee_id: '0'
15001+
team_assignee_id: '0'
15002+
created_at: 1719493065
15003+
updated_at: 1719493068
15004+
ticket_parts:
15005+
type: ticket_part.list
15006+
ticket_parts:
15007+
- type: ticket_part
15008+
id: '136'
15009+
part_type: ticket_state_updated_by_admin
15010+
ticket_state: submitted
15011+
previous_ticket_state: submitted
15012+
created_at: 1719493065
15013+
updated_at: 1719493065
15014+
author:
15015+
id: '991267920'
15016+
type: bot
15017+
name: Operator
15018+
email: operator+this_is_an_id664_that_should_be_at_least_@intercom.io
15019+
attachments: []
15020+
redacted: false
15021+
total_count: 1
15022+
open: true
15023+
linked_objects:
15024+
type: list
15025+
data: []
15026+
total_count: 0
15027+
has_more: false
15028+
category: Back-office
15029+
is_shared: false
15030+
ticket_state_internal_label: Submitted
15031+
ticket_state_external_label: Submitted
15032+
schema:
15033+
"$ref": "#/components/schemas/ticket"
15034+
'400':
15035+
description: Bad request
15036+
content:
15037+
application/json:
15038+
examples:
15039+
Missing ticket_type_id:
15040+
value:
15041+
type: error.list
15042+
request_id: a35b00e4-97b2-4b5d-a6f9-e82c4d8f7e12
15043+
errors:
15044+
- code: parameter_not_found
15045+
message: ticket_type_id is a required parameter
15046+
Missing ticket_state_id:
15047+
value:
15048+
type: error.list
15049+
request_id: b46c11f5-08c3-5c6e-b7a3-f93d5e8f9f23
15050+
errors:
15051+
- code: parameter_not_found
15052+
message: ticket_state_id is a required parameter
15053+
Same ticket type:
15054+
value:
15055+
type: error.list
15056+
request_id: f90a55j9-42g7-9g0i-f1e7-jd7h9i2j3j67
15057+
errors:
15058+
- code: parameter_invalid
15059+
message: Cannot change to the same ticket type
15060+
Ticket state not in new ticket type:
15061+
value:
15062+
type: error.list
15063+
request_id: g01b66k0-53h8-0h1j-g2f8-ke8i0j3k4k78
15064+
errors:
15065+
- code: parameter_invalid
15066+
message: Ticket custom state doesn't belong to the new ticket type
15067+
Unknown ticket attribute:
15068+
value:
15069+
type: error.list
15070+
request_id: h12c77l1-64i9-1i2k-h3g9-lf9j1k4l5l89
15071+
errors:
15072+
- code: parameter_invalid
15073+
message: 'Extra attributes provided that are not found on ticket type:
15074+
Priority'
15075+
schema:
15076+
"$ref": "#/components/schemas/error"
15077+
'401':
15078+
description: Unauthorized
15079+
content:
15080+
application/json:
15081+
examples:
15082+
Unauthorized:
15083+
value:
15084+
type: error.list
15085+
request_id: c57d22g6-19d4-6d7f-c8b4-ga4e6f9g0g34
15086+
errors:
15087+
- code: unauthorized
15088+
message: Access Token Invalid
15089+
schema:
15090+
"$ref": "#/components/schemas/error"
15091+
'404':
15092+
description: Ticket not found
15093+
content:
15094+
application/json:
15095+
examples:
15096+
Ticket not found:
15097+
value:
15098+
type: error.list
15099+
request_id: e79f44i8-31f6-8f9h-e0d6-ic6g8h1i2i56
15100+
errors:
15101+
- code: not_found
15102+
message: Resource Not Found
15103+
schema:
15104+
"$ref": "#/components/schemas/error"
15105+
requestBody:
15106+
content:
15107+
application/json:
15108+
schema:
15109+
"$ref": "#/components/schemas/change_ticket_type_request"
15110+
examples:
15111+
successful_response:
15112+
summary: Successful response
15113+
value:
15114+
ticket_type_id: '1234'
15115+
ticket_state_id: '5678'
1494315116
"/tickets/search":
1494415117
post:
1494515118
summary: Search tickets
@@ -17196,6 +17369,31 @@ components:
1719617369
type: integer
1719717370
description: "The Unix timestamp when the status reason was last updated"
1719817371
example: 1734537243
17372+
change_ticket_type_request:
17373+
title: Change Ticket Type Request
17374+
description: You can change the type of a Ticket
17375+
type: object
17376+
properties:
17377+
ticket_type_id:
17378+
type: string
17379+
description: The ID of the new ticket type. Must be in the same category
17380+
as the current type.
17381+
example: '1234'
17382+
ticket_state_id:
17383+
type: string
17384+
description: The ID of the ticket state for the new ticket type.
17385+
example: '5678'
17386+
ticket_attributes:
17387+
type: object
17388+
description: The attributes to set on the ticket for the new type. Attributes
17389+
matching by name and type are transferred automatically from the old type;
17390+
values provided here override the transferred values.
17391+
example:
17392+
_default_title_: example
17393+
_default_description_: having a problem
17394+
required:
17395+
- ticket_type_id
17396+
- ticket_state_id
1719917397
close_conversation_request:
1720017398
title: Close Conversation Request
1720117399
type: object

0 commit comments

Comments
 (0)