Archive a visitor conversation

200 means archived with data retained. All subsequent public access is denied. Repeated deletion is not guaranteed idempotent success; neither physical erasure nor immediate task cancellation is implied.

DELETE https://api.moi.matrixorigin.cn/v5/public/webapp/conversations/{conversation_id}

Before you call this API

BASE_URL uses the product API prefix https://api.moi.matrixorigin.cn/v5. For a dedicated deployment, use its corresponding product API address.

Prepare links and visitor identity in the same environment. Do not supply a product PAT or Workspace request header.

Request

curl --request DELETE \
  "$BASE_URL/public/webapp/conversations/$CONVERSATION_ID?webapp=$AGENT_ID&t=$WEBAPP_TOKEN&s=$WEBAPP_SESSION"

Parameter

Location

Type

Required

Description

webapp

Query

string

Yes

Agent ID corresponding to the link.

t

Query

string

Yes

Current valid publication token. For short-code links, resolve first and use the short code as t.

s

Query

string

Yes

Visitor session credentials under the same publication.

conversation_id

Path

string

Yes

Active Web App conversation created by this visitor.

Successful response

{
  "code": 0,
  "data": {
    "conversation_id": "conversation-example",
    "status": "archived"
  }
}

Success returns HTTP 200 with numeric code=0. Read data’s Object descriptions with the example; the conversation-creation example shows a field excerpt only.

Error response

Public errors and identity handling distinguishes unavailable links, disablement, invalid sessions, parameters, and system failures.

Last updated on