Skip to main content
PUT
/
{version}
/
{account_id}
/
{project_id}
/
chat
/
close
Close an existing chat conversation
curl --request PUT \
  --url https://api.us-1.platform.polyai.app/{version}/{account_id}/{project_id}/chat/close \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-TOKEN: <x-token>' \
  --data '
{
  "conversation_id": "CONV-1234567890"
}
'
{
  "success": true
}

Authorizations

​
X-API-KEY
string
header
required

You must request an API Key to use PolyAI APIs.

Headers

​
X-API-KEY
string
required

Your PolyAI API key.

​
X-TOKEN
string
required

Agent authentication token (connector).

Path Parameters

​
version
string
required

API version

​
account_id
string
required

Account ID

​
project_id
string
required

Project ID

Body

application/json
​
conversation_id
string
required

ID of the conversation to close

Example:

"CONV-1234567890"

Response

OK

​
success
boolean
required

Whether the conversation was successfully closed

Example:

true