Close a conversation

PATCH

/v2/health-navigator/conversations/close

curl --request PATCH \
  --url https://client-api.abi.ai/v2/health-navigator/conversations/close \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "userId": "abi12345" }'

• Abi Client API

Close an active Health Navigator chat session. Sessions are also closed automatically after 2 hours without a user message; once closed, no further input is allowed.

Authorizations

• bearerAuth

Request Body^required

Media typeapplication/json

object

userId

required

Abi user identifier whose active conversation should be closed.

string

Example

abi12345

Example

{
  "userId": "abi12345"
}

Responses

200

Conversation closed. No further messages can be sent to the closed session.

Media typeapplication/json

object

userId

Abi user identifier for the conversation.

string

conversationInfo

object

id

Conversation identifier.

string

status

Current conversation lifecycle status.

string

Allowed values: OPEN WAITING_FOR_RESPONSE RESOLVED CLOSED

Example

{
  "userId": "abi12345",
  "conversationInfo": {
    "id": "01HK8GGQ123456789ABCDEFGHI",
    "status": "CLOSED"
  }
}

400

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}

404

Request could not be completed.

Media typeapplication/json

object

code

Short machine-readable error code.

string

message

Human-readable explanation of the error.

string

Example^generated

{
  "code": "example",
  "message": "example"
}