Skip to content

Commit a54201c

Browse files
committed
changes
1 parent 1024a8e commit a54201c

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

descriptions/0/api.intercom.io.yaml

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6753,10 +6753,9 @@ paths:
67536753
- name: retain_metrics
67546754
in: query
67556755
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.
6756+
description: If true (default), deletes the conversation while retaining reporting
6757+
data. If false, deletes the conversation and all associated reporting data.
6758+
Setting to false requires the `permanently_delete_conversations` OAuth scope.
67606759
example: true
67616760
schema:
67626761
type: boolean
@@ -6770,9 +6769,13 @@ paths:
67706769

67716770
You can delete a single conversation. The behavior depends on the `retain_metrics` parameter:
67726771

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.
6772+
- **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.
67746773

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.
6774+
- **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.
6775+
6776+
{% admonition type="info" name="Required scope for retain_metrics=false" %}
6777+
Using `retain_metrics=false` requires the `permanently_delete_conversations` OAuth scope.
6778+
{% /admonition %}
67766779
responses:
67776780
'200':
67786781
description: successful

0 commit comments

Comments
 (0)