Skip to main content
POST
Close Conversation

Description

Closes an active conversation in the external support panel. Allows specifying a closing message to send to the user and the reason for closing. Upon execution, Jelou emits the conversation.close event to the webhook configured in the integration.

Endpoint

Path parameters

string
required
Unique identifier of the Jelou project from which the conversation is closed.

Body parameters

string
required
Identifier of the Jelou bot associated with the conversation.
string
required
Identifier of the end user whose conversation you want to close.
object
Message to be sent to the user at the time of closing the conversation.
  • type — Message type: text or edge.
  • text — Text of the closing message (when type is text).

Authentication

All requests must include the x-api-key header with your Jelou project API key.

Request example

The following example closes the conversation for user USER_ID and includes a closing message:
cURL

Responses

Response example


Webhook event conversation.close

When this resource is executed, Jelou will emit the conversation.close event to the webhook configured in the integration. The payload includes the close reason and the message sent to the user.

Payload fields

Authorizations

x-api-key
string
header
required

API key del proyecto de Jelou

Path Parameters

projectId
string
required

Unique identifier of the Jelou project

Body

application/json
botId
string
required
userId
string
required
redirectPayload
object

Response

Conversation closed successfully