diff --git a/descriptions/0/api.intercom.io.yaml b/descriptions/0/api.intercom.io.yaml index f4f7d55..0b0acb1 100644 --- a/descriptions/0/api.intercom.io.yaml +++ b/descriptions/0/api.intercom.io.yaml @@ -6750,6 +6750,15 @@ paths: required: true schema: type: integer + - name: retain_metrics + in: query + required: false + description: If true (default), deletes the conversation while retaining reporting + data. If false, deletes the conversation and all associated reporting data. + Setting to false requires the `permanently_delete_conversations` OAuth scope. + example: true + schema: + type: boolean tags: - Conversations operationId: deleteConversation @@ -6758,7 +6767,15 @@ paths: Deleting a conversation is permanent and cannot be reversed. {% /admonition %} - 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. + You can delete a single conversation. The behavior depends on the `retain_metrics` parameter: + + - **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. + + - **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. + + {% admonition type="info" name="Required scope for retain_metrics=false" %} + Using `retain_metrics=false` requires the `permanently_delete_conversations` OAuth scope. + {% /admonition %} responses: '200': description: successful