Skip to main content
GuidesAPI Reference

Close a conversation

POST 
/rest/api/conversation/close

Closes a specific conversation with a disposition, and optionally attaches a closing note and attachments.

The agent named in agentUsername / agentUUID does not have to be the agent currently assigned to the conversation. When it is a different agent, Converse 2.0 checks that they hold the privilege to close it and rejects the call if they do not.

dispositionUUID must already exist — the operation fails if it does not. Retrieve valid dispositions for the conversation's queue with the Converse 2.0 Setup API's List queues operation, passing disposition: true.

Request​

Responses​

The standard Converse 2.0 envelope. A rejected operation is also returned with HTTP 200 and status: "Failed" — check status, not only the HTTP status code.