removeParticipant

Remove a Participant from a Conversation.

DELETE/conversations/{conversationId}/participants/{userId}

Header parameters

x-user-keystringrequired

Authentication Key

Path parameters

conversationIdstringrequired

Conversation id

userIdstringrequired

User id

Response

application/json

Returns an empty object

The response is of type removeParticipantResponse · object.

Request

curl --request DELETE \ \
  --url https://chat.botpress.cloud/your_default_webhook_url/conversations/{conversationId}/participants/{userId} \
  --header 'x-user-key: <x-user-key>' \
  --header 'Authorization: Bearer <token>'

Response

{}