Close an existing chat conversation

Closes an active chat conversation and marks it as complete.

put/{version}/{account_id}/{project_id}/chat/close

Request

Base URL
https://api.us.poly.ai
Auth
- API key in header x-api-key
- or API key in header X-TOKEN
TypeScript
https://skmtc.dev/poly/apis/polyai-agents-api/docs/:version/:account_id/:project_id/chat/close/put.ts
A function with typed inputs. Its response is checked against the schema.

versionstring required

API version

account_idstring required

Account ID

project_idstring required

Project ID

X-API-KEYstring required

Your PolyAI API key.

X-TOKENstring required

Agent authentication token (connector).

conversation_idstring required

ID of the conversation to close

{
  "conversation_id": "CONV-1234567890"
}

successboolean required

Whether the conversation was successfully closed

{
  "success": true
}

No recorded changes to this operation across all 1 revision of this API.