DID THIS ARTICLE SOLVE YOUR ISSUE?
Let us know so we can improve!
Let us know so we can improve!
Signal that the entire conversation is complete across all sessions. Closing a conversation also closes any remaining open sessions.
URI: /api/v1/agentic/conversations/{conversationId}/close
HTTP Method: POST
Authentication: Bearer JWT
| Parameter | Required | Description |
|---|---|---|
| conversationId | Yes | Conversation identifier. |
| Header | Required | Description |
|---|---|---|
| Authorization | Yes | Bearer JWT token. |
| agent_id | Yes | Registered agent API name. |
No request body required.
| Field | Type | Description |
|---|---|---|
| statusCode | String | Operation status. Value: closed. |
| conversationId | String | The closed conversation identifier. |
Status: 202 Accepted
1{
2 "statusCode": "closed",
3 "conversationId": "<conversationId>"
4}| Status Code | Description |
|---|---|
| 401 | Unauthorized. Invalid or missing JWT token. |
| 404 | Not Found. Conversation does not exist. |
| 500 | Internal Server Error. |