Skip to content

Commit 22153e2

Browse files
VarshSureshclaude
andcommitted
Add GET /conversations/deleted endpoint to Unstable API spec
Add new endpoint to retrieve deleted conversation IDs with deletion timestamps for compliance and audit purposes. Changes: - Added /conversations/deleted GET endpoint with pagination support - Added deleted_conversation_item schema - Added deleted_conversation_list schema - Fixed response structure to use 'conversations' array key (consistent with conversation_list) - All examples use updated_at field for deletion timestamp Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
1 parent e00872f commit 22153e2

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
@@ -8556,6 +8556,100 @@ paths:
85568556
summary: Bad request
85578557
value:
85588558
ticket_type_id: '54'
8559+
"/conversations/deleted":
8560+
get:
8561+
summary: List all deleted conversation IDs
8562+
parameters:
8563+
- name: Intercom-Version
8564+
in: header
8565+
schema:
8566+
"$ref": "#/components/schemas/intercom_version"
8567+
- name: page
8568+
in: query
8569+
required: false
8570+
description: The page of results to fetch. Defaults to first page
8571+
example: 1
8572+
schema:
8573+
type: integer
8574+
- name: per_page
8575+
in: query
8576+
required: false
8577+
description: How many results per page
8578+
schema:
8579+
type: integer
8580+
default: 20
8581+
maximum: 60
8582+
- name: order
8583+
in: query
8584+
required: false
8585+
description: "`asc` or `desc`. Returns the conversation IDs in ascending or descending order. Defaults to desc"
8586+
example: desc
8587+
schema:
8588+
type: string
8589+
tags:
8590+
- Conversations
8591+
operationId: listDeletedConversationIds
8592+
description: |+
8593+
List all deleted conversation IDs.
8594+
8595+
{% admonition type="warning" name="Pagination" %}
8596+
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.
8597+
{% /admonition %}
8598+
responses:
8599+
'200':
8600+
description: View all deleted conversation IDs
8601+
content:
8602+
application/json:
8603+
examples:
8604+
successful:
8605+
value:
8606+
type: conversations.list
8607+
total_count: 4
8608+
pages:
8609+
type: pages
8610+
next: https://api.intercom.io/conversations/deleted?per_page=2&order=desc&page=2
8611+
page: 1
8612+
per_page: 2
8613+
total_pages: 2
8614+
conversations:
8615+
- type: conversation
8616+
id: '512'
8617+
metrics_retained: false
8618+
updated_at: 1734537460
8619+
- type: conversation
8620+
id: '513'
8621+
metrics_retained: true
8622+
updated_at: 1734537400
8623+
schema:
8624+
"$ref": "#/components/schemas/deleted_conversation_list"
8625+
'401':
8626+
description: Unauthorized
8627+
content:
8628+
application/json:
8629+
examples:
8630+
Unauthorized:
8631+
value:
8632+
type: error.list
8633+
request_id: 310f55b0-2660-43e8-bed4-7e82b2f40920
8634+
errors:
8635+
- code: unauthorized
8636+
message: Access Token Invalid
8637+
schema:
8638+
"$ref": "#/components/schemas/error"
8639+
'400':
8640+
description: Resource not available
8641+
content:
8642+
application/json:
8643+
examples:
8644+
Resource not available:
8645+
value:
8646+
type: error.list
8647+
request_id: 7a80b950-b392-499f-85db-ea7c6c424d37
8648+
errors:
8649+
- code: intercom_version_invalid
8650+
message: Requested resource is not available in current API version.
8651+
schema:
8652+
"$ref": "#/components/schemas/error"
85598653
"/custom_channel_events/notify_new_conversation":
85608654
post:
85618655
summary: Notify Intercom of a new conversation created in a custom channel
@@ -18510,6 +18604,50 @@ components:
1851018604
type: boolean
1851118605
description: Whether the conversation is deleted or not.
1851218606
example: true
18607+
deleted_conversation_item:
18608+
title: Conversation
18609+
type: object
18610+
x-tags:
18611+
- Conversation
18612+
description: A deleted conversation record containing its ID, metrics retained status and deletion timestamp.
18613+
properties:
18614+
type:
18615+
type: string
18616+
description: String representing the object's type. Always has the value `conversation`.
18617+
example: 'conversation'
18618+
id:
18619+
type: string
18620+
description: The ID of the deleted conversation.
18621+
example: '512'
18622+
metrics_retained:
18623+
type: boolean
18624+
description: Whether reporting metrics are retained for this conversation ID
18625+
example: true
18626+
updated_at:
18627+
type: integer
18628+
format: date-time
18629+
description: The time when the conversation was deleted.
18630+
example: 1734537745
18631+
deleted_conversation_list:
18632+
title: Conversations
18633+
type: object
18634+
description: A paginated list of deleted conversation IDs.
18635+
properties:
18636+
type:
18637+
type: string
18638+
description: String representing the object's type. Always has the value `conversations.list`.
18639+
example: conversations.list
18640+
conversations:
18641+
type: array
18642+
description: The list of deleted conversation IDs.
18643+
items:
18644+
"$ref": "#/components/schemas/deleted_conversation_item"
18645+
total_count:
18646+
type: integer
18647+
description: Total number of items available.
18648+
example: 10
18649+
pages:
18650+
"$ref": "#/components/schemas/pages_link"
1851318651
conversation_first_contact_reply:
1851418652
title: First contact reply
1851518653
type: object

0 commit comments

Comments
 (0)