Skip to content

Commit 1024a8e

Browse files
committed
conversation delete endpoint retain metrics and permission
1 parent f7655dd commit 1024a8e

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6750,6 +6750,16 @@ paths:
67506750
required: true
67516751
schema:
67526752
type: integer
6753+
- name: retain_metrics
6754+
in: query
6755+
required: false
6756+
description: If true (default), soft deletes the conversation but retains it
6757+
in reporting. If false, permanently deletes all conversation data including
6758+
metrics. Setting to false requires the `permanently_delete_conversations`
6759+
OAuth scope.
6760+
example: true
6761+
schema:
6762+
type: boolean
67536763
tags:
67546764
- Conversations
67556765
operationId: deleteConversation
@@ -6758,7 +6768,11 @@ paths:
67586768
Deleting a conversation is permanent and cannot be reversed.
67596769
{% /admonition %}
67606770

6761-
Deleting a conversation permanently removes it from the inbox. All sensitive data is deleted, including admin and user replies, conversation attributes, uploads, and related content. The conversation will still appear in reporting, though some data may be incomplete due to the deletion.
6771+
You can delete a single conversation. The behavior depends on the `retain_metrics` parameter:
6772+
6773+
- **With `retain_metrics=true` (default)**: Soft deletes the conversation, removing sensitive data (admin and user replies, conversation attributes, uploads, and related content). The conversation will still appear in reporting, though some data may be incomplete due to the deletion.
6774+
6775+
- **With `retain_metrics=false`**: Permanently deletes ALL conversation data including metrics. This requires the `permanently_delete_conversations` OAuth scope. The conversation will be completely removed from both the inbox and all reporting.
67626776
responses:
67636777
'200':
67646778
description: successful

0 commit comments

Comments
 (0)