Close Conversation

POST/v1/conversations/close

Updates conversation status to Closed (Resolved), with optional category and summary.

Body

conversationIdstring•The ID of the conversation to close. required

Example:60f1234567890abcdef12345

closingNoteIdstring•Optional category or closing note ID.

Example:01kyn6qneqzqsemg0n2bdrm105

summarystring•Optional summary of the resolution.

Example:Resolved customer inquiry

Responses

Body

success_codeenum: 200 | 201•Numeric success code matching the HTTP response status. required

Example:200

messagestring required

Example:OK

detailsobject required

dataobject required

metaobject

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

error_codeinteger•Numeric error code matching the HTTP response status. required

Example:400

messagestring required

detailsobject•Validation errors are returned as a field-to-messages map; other errors may use arbitrary keys. required

Request Sample:Shell / cURL

1
2
3
4

curl --request POST \
  --url "https://api-stg.bevatelcloud.com/v1/conversations/close" \
  --header "Authorization: Bearer <YOUR_API_KEY>" \
  --header "Content-Type: application/json"

Response Example

1
2
3
4
5
6

{
  "success_code": 200,
  "message": "OK",
  "details": {},
  "meta": {}
}