Skip to main content
DELETE
/
v1
/
api
/
conversations
/
{id}
Delete a conversation
curl --request DELETE \
  --url https://api.hq.zone/v1/api/conversations/{id} \
  --header 'Authorization: Bearer <token>'
{
  "apps_destroyed": 1,
  "artifacts_deleted": 1,
  "artifacts_kept": 1,
  "conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Authorizations

Authorization
string
header
required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Path Parameters

id
string<uuid>
required

Conversation id

Query Parameters

delete_artifacts
boolean

true also permanently deletes the conversation's delivered artifacts (blobs + rows). Default false - keep them (detach).

Response

Conversation deleted (cascade)

apps_destroyed
integer
required
Required range: x >= 0
artifacts_deleted
integer
required

Delivered artifacts whose Trove blobs + rows were deleted (when the caller asked to delete them).

Required range: x >= 0
artifacts_kept
integer
required

Delivered artifacts detached (conversation_id -> NULL) and kept in Trove - the default. They survive the conversation, still downloadable by their existing /v1/api/artifacts/{id}/download link, just no longer tied to a (now-deleted) conversation.

Required range: x >= 0
conversation_id
string<uuid>
required