Skip to content

Commit 1c14a2a

Browse files
marcmlcmarcmlc
authored
update delete tickets endpoint doc (#371)
1 parent 08c44a4 commit 1c14a2a

4 files changed

Lines changed: 164 additions & 204 deletions

File tree

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

Lines changed: 41 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -14330,7 +14330,12 @@ paths:
1433014330
tags:
1433114331
- Tickets
1433214332
operationId: deleteTicket
14333-
description: You can delete a ticket using the Intercom provided ID.
14333+
description: |
14334+
{% admonition type="warning" name="Irreversible operation" %}
14335+
Deleting a ticket is permanent and cannot be reversed.
14336+
{% /admonition %}
14337+
14338+
Deleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion.
1433414339
responses:
1433514340
'200':
1433614341
description: successful
@@ -14343,24 +14348,7 @@ paths:
1434314348
object: ticket
1434414349
deleted: true
1434514350
schema:
14346-
title: Ticket Deleted
14347-
type: object
14348-
description: Response when a ticket is deleted.
14349-
properties:
14350-
id:
14351-
type: string
14352-
description: The unique identifier for the ticket.
14353-
example: '42'
14354-
object:
14355-
type: string
14356-
description: always ticket
14357-
enum:
14358-
- ticket
14359-
example: ticket
14360-
deleted:
14361-
type: boolean
14362-
description: Whether the ticket is deleted or not.
14363-
example: true
14351+
"$ref": "#/components/schemas/ticket_deleted"
1436414352
'404':
1436514353
description: Ticket not found
1436614354
content:
@@ -14374,38 +14362,7 @@ paths:
1437414362
- code: ticket_not_found
1437514363
message: Ticket not found
1437614364
schema:
14377-
type: object
14378-
title: Ticket not found error
14379-
properties:
14380-
type:
14381-
type: string
14382-
description: The type is error.list
14383-
example: error.list
14384-
request_id:
14385-
type: string
14386-
nullable: true
14387-
format: uuid
14388-
description: ''
14389-
example: f93ecfa8-d08a-4325-8694-89aeb89c8f85
14390-
errors:
14391-
type: array
14392-
description: An array of one or more error objects
14393-
items:
14394-
properties:
14395-
code:
14396-
type: string
14397-
description: ticket_not_found
14398-
example: ticket_not_found
14399-
message:
14400-
type: string
14401-
nullable: true
14402-
description: Ticket not found
14403-
example: Ticket not found
14404-
required:
14405-
- code
14406-
required:
14407-
- type
14408-
- errors
14365+
"$ref": "#/components/schemas/error"
1440914366
'401':
1441014367
description: Unauthorized
1441114368
content:
@@ -14420,6 +14377,20 @@ paths:
1442014377
message: Access Token Invalid
1442114378
schema:
1442214379
"$ref": "#/components/schemas/error"
14380+
'403':
14381+
description: API plan restricted
14382+
content:
14383+
application/json:
14384+
examples:
14385+
API plan restricted:
14386+
value:
14387+
type: error.list
14388+
request_id: 7a80b950-b392-499f-85db-ea7c6c424d37
14389+
errors:
14390+
- code: api_plan_restricted
14391+
message: Active subscription needed.
14392+
schema:
14393+
"$ref": "#/components/schemas/error"
1442314394
"/tickets/search":
1442414395
post:
1442514396
summary: Search tickets
@@ -22707,6 +22678,25 @@ components:
2270722678
type: boolean
2270822679
description: Whether or not the ticket is shared with the customer.
2270922680
example: true
22681+
ticket_deleted:
22682+
title: Ticket Deleted
22683+
type: object
22684+
description: deleted ticket object
22685+
properties:
22686+
id:
22687+
type: string
22688+
description: The unique identifier for the ticket.
22689+
example: 5ba682d23d7cf92bef87bfd4
22690+
object:
22691+
type: string
22692+
description: always ticket
22693+
enum:
22694+
- ticket
22695+
example: ticket
22696+
deleted:
22697+
type: boolean
22698+
description: Whether the ticket is deleted or not.
22699+
example: true
2271022700
ticket_contacts:
2271122701
title: Contacts
2271222702
type: object

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

Lines changed: 41 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -12326,7 +12326,12 @@ paths:
1232612326
tags:
1232712327
- Tickets
1232812328
operationId: deleteTicket
12329-
description: You can delete a ticket using the Intercom provided ID.
12329+
description: |
12330+
{% admonition type="warning" name="Irreversible operation" %}
12331+
Deleting a ticket is permanent and cannot be reversed.
12332+
{% /admonition %}
12333+
12334+
Deleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion.
1233012335
responses:
1233112336
'200':
1233212337
description: successful
@@ -12339,24 +12344,7 @@ paths:
1233912344
object: ticket
1234012345
deleted: true
1234112346
schema:
12342-
title: Ticket Deleted
12343-
type: object
12344-
description: Response when a ticket is deleted.
12345-
properties:
12346-
id:
12347-
type: string
12348-
description: The unique identifier for the ticket.
12349-
example: '42'
12350-
object:
12351-
type: string
12352-
description: always ticket
12353-
enum:
12354-
- ticket
12355-
example: ticket
12356-
deleted:
12357-
type: boolean
12358-
description: Whether the ticket is deleted or not.
12359-
example: true
12347+
"$ref": "#/components/schemas/ticket_deleted"
1236012348
'404':
1236112349
description: Ticket not found
1236212350
content:
@@ -12370,38 +12358,7 @@ paths:
1237012358
- code: ticket_not_found
1237112359
message: Ticket not found
1237212360
schema:
12373-
type: object
12374-
title: Ticket not found error
12375-
properties:
12376-
type:
12377-
type: string
12378-
description: The type is error.list
12379-
example: error.list
12380-
request_id:
12381-
type: string
12382-
nullable: true
12383-
format: uuid
12384-
description: ''
12385-
example: f93ecfa8-d08a-4325-8694-89aeb89c8f85
12386-
errors:
12387-
type: array
12388-
description: An array of one or more error objects
12389-
items:
12390-
properties:
12391-
code:
12392-
type: string
12393-
description: ticket_not_found
12394-
example: ticket_not_found
12395-
message:
12396-
type: string
12397-
nullable: true
12398-
description: Ticket not found
12399-
example: Ticket not found
12400-
required:
12401-
- code
12402-
required:
12403-
- type
12404-
- errors
12361+
"$ref": "#/components/schemas/error"
1240512362
'401':
1240612363
description: Unauthorized
1240712364
content:
@@ -12416,6 +12373,20 @@ paths:
1241612373
message: Access Token Invalid
1241712374
schema:
1241812375
"$ref": "#/components/schemas/error"
12376+
'403':
12377+
description: API plan restricted
12378+
content:
12379+
application/json:
12380+
examples:
12381+
API plan restricted:
12382+
value:
12383+
type: error.list
12384+
request_id: 7a80b950-b392-499f-85db-ea7c6c424d37
12385+
errors:
12386+
- code: api_plan_restricted
12387+
message: Active subscription needed.
12388+
schema:
12389+
"$ref": "#/components/schemas/error"
1241912390
"/tickets/search":
1242012391
post:
1242112392
summary: Search tickets
@@ -19095,6 +19066,25 @@ components:
1909519066
type: boolean
1909619067
description: Whether or not the ticket is shared with the customer.
1909719068
example: true
19069+
ticket_deleted:
19070+
title: Ticket Deleted
19071+
type: object
19072+
description: deleted ticket object
19073+
properties:
19074+
id:
19075+
type: string
19076+
description: The unique identifier for the ticket.
19077+
example: 5ba682d23d7cf92bef87bfd4
19078+
object:
19079+
type: string
19080+
description: always ticket
19081+
enum:
19082+
- ticket
19083+
example: ticket
19084+
deleted:
19085+
type: boolean
19086+
description: Whether the ticket is deleted or not.
19087+
example: true
1909819088
ticket_contacts:
1909919089
title: Contacts
1910019090
type: object

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

Lines changed: 41 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -13495,7 +13495,12 @@ paths:
1349513495
tags:
1349613496
- Tickets
1349713497
operationId: deleteTicket
13498-
description: You can delete a ticket using the Intercom provided ID.
13498+
description: |
13499+
{% admonition type="warning" name="Irreversible operation" %}
13500+
Deleting a ticket is permanent and cannot be reversed.
13501+
{% /admonition %}
13502+
13503+
Deleting a ticket permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, ticket attributes, uploads, and related content. The ticket will still appear in reporting, though some data may be incomplete due to the deletion.
1349913504
responses:
1350013505
'200':
1350113506
description: successful
@@ -13508,24 +13513,7 @@ paths:
1350813513
object: ticket
1350913514
deleted: true
1351013515
schema:
13511-
title: Ticket Deleted
13512-
type: object
13513-
description: Response when a ticket is deleted.
13514-
properties:
13515-
id:
13516-
type: string
13517-
description: The unique identifier for the ticket.
13518-
example: '42'
13519-
object:
13520-
type: string
13521-
description: always ticket
13522-
enum:
13523-
- ticket
13524-
example: ticket
13525-
deleted:
13526-
type: boolean
13527-
description: Whether the ticket is deleted or not.
13528-
example: true
13516+
"$ref": "#/components/schemas/ticket_deleted"
1352913517
'404':
1353013518
description: Ticket not found
1353113519
content:
@@ -13539,38 +13527,7 @@ paths:
1353913527
- code: ticket_not_found
1354013528
message: Ticket not found
1354113529
schema:
13542-
type: object
13543-
title: Ticket not found error
13544-
properties:
13545-
type:
13546-
type: string
13547-
description: The type is error.list
13548-
example: error.list
13549-
request_id:
13550-
type: string
13551-
nullable: true
13552-
format: uuid
13553-
description: ''
13554-
example: f93ecfa8-d08a-4325-8694-89aeb89c8f85
13555-
errors:
13556-
type: array
13557-
description: An array of one or more error objects
13558-
items:
13559-
properties:
13560-
code:
13561-
type: string
13562-
description: ticket_not_found
13563-
example: ticket_not_found
13564-
message:
13565-
type: string
13566-
nullable: true
13567-
description: Ticket not found
13568-
example: Ticket not found
13569-
required:
13570-
- code
13571-
required:
13572-
- type
13573-
- errors
13530+
"$ref": "#/components/schemas/error"
1357413531
'401':
1357513532
description: Unauthorized
1357613533
content:
@@ -13585,6 +13542,20 @@ paths:
1358513542
message: Access Token Invalid
1358613543
schema:
1358713544
"$ref": "#/components/schemas/error"
13545+
'403':
13546+
description: API plan restricted
13547+
content:
13548+
application/json:
13549+
examples:
13550+
API plan restricted:
13551+
value:
13552+
type: error.list
13553+
request_id: 7a80b950-b392-499f-85db-ea7c6c424d37
13554+
errors:
13555+
- code: api_plan_restricted
13556+
message: Active subscription needed.
13557+
schema:
13558+
"$ref": "#/components/schemas/error"
1358813559
"/tickets/search":
1358913560
post:
1359013561
summary: Search tickets
@@ -21025,6 +20996,25 @@ components:
2102520996
type: boolean
2102620997
description: Whether or not the ticket is shared with the customer.
2102720998
example: true
20999+
ticket_deleted:
21000+
title: Ticket Deleted
21001+
type: object
21002+
description: deleted ticket object
21003+
properties:
21004+
id:
21005+
type: string
21006+
description: The unique identifier for the ticket.
21007+
example: 5ba682d23d7cf92bef87bfd4
21008+
object:
21009+
type: string
21010+
description: always ticket
21011+
enum:
21012+
- ticket
21013+
example: ticket
21014+
deleted:
21015+
type: boolean
21016+
description: Whether the ticket is deleted or not.
21017+
example: true
2102821018
ticket_contacts:
2102921019
title: Contacts
2103021020
type: object

0 commit comments

Comments
 (0)