Intercom API (unofficial showcase)
DELETE/conversations/{conversation_id}

Delete a conversation

Deletes a conversation, with reporting-data retention controlled by retain_metrics. The default retains reporting data; set retain_metrics to false to remove the conversation's associated reporting data as well, which requires the delete_conversations_and_metrics OAuth scope.

Deleting a conversation is permanent and cannot be reversed.

3 parameters
conversation_idintegerrequired
The unique identifier of the conversation to delete.
retain_metricsbooleanoptional
Whether to retain reporting data after deletion. Defaults to true when omitted; setting it to false also deletes the associated reporting data and requires the `delete_conversations_and_metrics` OAuth scope.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the deleted conversation object, including its identifier, object type, and deletion status.
idstringoptional
The unique identifier for the conversation.
objectstringoptional
always conversation
Allowed:conversation
deletedbooleanoptional
Whether the conversation is deleted or not.
401Returned when the request is not authenticated.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
403Returned when the API plan restricts conversation deletion.

One documented failure

  • api_plan_restricted

    Active subscription needed.

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when authentication is missing or invalid. A 403 is returned when the API plan restricts this operation. The conversation_id path parameter must identify a conversation, and setting retain_metrics to false requires the delete_conversations_and_metrics OAuth scope.