Skip to content

Commit dff5ea7

Browse files
marcmlcclaude
andauthored
conversation delete endpoint retain metrics and permission (#379)
* conversation delete endpoint retain metrics and permission * changes * Rename OAuth scope from permanently_delete_conversations to delete_conversations_and_metrics Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 5b01fc5 commit dff5ea7

1 file changed

Lines changed: 18 additions & 1 deletion

File tree

descriptions/0/api.intercom.io.yaml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6874,6 +6874,15 @@ paths:
68746874
required: true
68756875
schema:
68766876
type: integer
6877+
- name: retain_metrics
6878+
in: query
6879+
required: false
6880+
description: If true (default), deletes the conversation while retaining reporting
6881+
data. If false, deletes the conversation and all associated reporting data.
6882+
Setting to false requires the `delete_conversations_and_metrics` OAuth scope.
6883+
example: true
6884+
schema:
6885+
type: boolean
68776886
tags:
68786887
- Conversations
68796888
operationId: deleteConversation
@@ -6882,7 +6891,15 @@ paths:
68826891
Deleting a conversation is permanent and cannot be reversed.
68836892
{% /admonition %}
68846893

6885-
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.
6894+
You can delete a single conversation. The behavior depends on the `retain_metrics` parameter:
6895+
6896+
- **With `retain_metrics=true` (default)**: Deletes the conversation while retaining reporting data. The conversation will still appear in reporting, though some data may be incomplete due to the deletion.
6897+
6898+
- **With `retain_metrics=false`**: Deletes the conversation and all associated reporting data. The conversation will be completely removed from both the inbox and all reporting.
6899+
6900+
{% admonition type="info" name="Required scope for retain_metrics=false" %}
6901+
Using `retain_metrics=false` requires the `delete_conversations_and_metrics` OAuth scope.
6902+
{% /admonition %}
68866903
responses:
68876904
'200':
68886905
description: successful

0 commit comments

Comments
 (0)