Skip to content

Commit de8989b

Browse files
committed
docs: Re-add GET /conversations/deleted endpoint to Unstable API spec
1 parent 34bef98 commit de8989b

File tree

1 file changed

+138
-0
lines changed

1 file changed

+138
-0
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9185,6 +9185,100 @@ paths:
91859185
summary: Bad request
91869186
value:
91879187
ticket_type_id: '54'
9188+
"/conversations/deleted":
9189+
get:
9190+
summary: List all deleted conversation IDs
9191+
parameters:
9192+
- name: Intercom-Version
9193+
in: header
9194+
schema:
9195+
"$ref": "#/components/schemas/intercom_version"
9196+
- name: page
9197+
in: query
9198+
required: false
9199+
description: The page of results to fetch. Defaults to first page
9200+
example: 1
9201+
schema:
9202+
type: integer
9203+
- name: per_page
9204+
in: query
9205+
required: false
9206+
description: How many results per page
9207+
schema:
9208+
type: integer
9209+
default: 20
9210+
maximum: 60
9211+
- name: order
9212+
in: query
9213+
required: false
9214+
description: "`asc` or `desc`. Returns the conversation IDs in ascending or descending order. Defaults to desc"
9215+
example: desc
9216+
schema:
9217+
type: string
9218+
tags:
9219+
- Conversations
9220+
operationId: listDeletedConversationIds
9221+
description: |+
9222+
List all deleted conversation IDs.
9223+
9224+
{% admonition type="warning" name="Pagination" %}
9225+
You can use pagination to limit the number of results returned. The default is `20` results per page. You can navigate to next pages using the `page` param.
9226+
{% /admonition %}
9227+
responses:
9228+
'200':
9229+
description: View all deleted conversation IDs
9230+
content:
9231+
application/json:
9232+
examples:
9233+
successful:
9234+
value:
9235+
type: conversations.list
9236+
total_count: 4
9237+
pages:
9238+
type: pages
9239+
next: https://api.intercom.io/conversations/deleted?per_page=2&order=desc&page=2
9240+
page: 1
9241+
per_page: 2
9242+
total_pages: 2
9243+
conversations:
9244+
- type: conversation
9245+
id: '512'
9246+
metrics_retained: false
9247+
deleted_at: 1734537460
9248+
- type: conversation
9249+
id: '513'
9250+
metrics_retained: true
9251+
deleted_at: 1734537400
9252+
schema:
9253+
"$ref": "#/components/schemas/deleted_conversation_list"
9254+
'401':
9255+
description: Unauthorized
9256+
content:
9257+
application/json:
9258+
examples:
9259+
Unauthorized:
9260+
value:
9261+
type: error.list
9262+
request_id: 310f55b0-2660-43e8-bed4-7e82b2f40920
9263+
errors:
9264+
- code: unauthorized
9265+
message: Access Token Invalid
9266+
schema:
9267+
"$ref": "#/components/schemas/error"
9268+
'400':
9269+
description: Resource not available
9270+
content:
9271+
application/json:
9272+
examples:
9273+
Resource not available:
9274+
value:
9275+
type: error.list
9276+
request_id: 7a80b950-b392-499f-85db-ea7c6c424d37
9277+
errors:
9278+
- code: intercom_version_invalid
9279+
message: Requested resource is not available in current API version.
9280+
schema:
9281+
"$ref": "#/components/schemas/error"
91889282
"/custom_channel_events/notify_new_conversation":
91899283
post:
91909284
summary: Notify Intercom of a new conversation created in a custom channel
@@ -19800,6 +19894,50 @@ components:
1980019894
type: boolean
1980119895
description: Whether the conversation is deleted or not.
1980219896
example: true
19897+
deleted_conversation_item:
19898+
title: Conversation
19899+
type: object
19900+
x-tags:
19901+
- Conversation
19902+
description: A deleted conversation record containing its ID, metrics retained status and deletion timestamp.
19903+
properties:
19904+
type:
19905+
type: string
19906+
description: String representing the object's type. Always has the value `conversation`.
19907+
example: 'conversation'
19908+
id:
19909+
type: string
19910+
description: The ID of the deleted conversation.
19911+
example: '512'
19912+
metrics_retained:
19913+
type: boolean
19914+
description: Whether reporting metrics are retained for this conversation ID
19915+
example: true
19916+
deleted_at:
19917+
type: integer
19918+
format: date-time
19919+
description: The time when the conversation was deleted.
19920+
example: 1734537745
19921+
deleted_conversation_list:
19922+
title: Conversations
19923+
type: object
19924+
description: A paginated list of deleted conversation IDs.
19925+
properties:
19926+
type:
19927+
type: string
19928+
description: String representing the object's type. Always has the value `conversations.list`.
19929+
example: conversations.list
19930+
conversations:
19931+
type: array
19932+
description: The list of deleted conversation IDs.
19933+
items:
19934+
"$ref": "#/components/schemas/deleted_conversation_item"
19935+
total_count:
19936+
type: integer
19937+
description: Total number of items available.
19938+
example: 10
19939+
pages:
19940+
"$ref": "#/components/schemas/pages_link"
1980319941
conversation_first_contact_reply:
1980419942
title: First contact reply
1980519943
type: object

0 commit comments

Comments
 (0)