removeParticipant

Remove a Participant from a Conversation.

DELETE/v1/chat/conversations/{id}/participants/{userId}

Authorization

AuthorizationBearer

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header parameters

x-bp-authenticated-principalstring

Authenticated principal. Injected by the authentication middleware.

x-bot-idstring

Bot id

x-integration-id?string

Integration id

x-integration-alias?string

Integration alias

Path parameters

idstring

Conversation id

userIdstring

User id

Response

Returns an empty object

Request

curl --request DELETE \ \
  --url https://api.botpress.cloud/v1/chat/conversations/{id}/participants/{userId} \
  --header 'x-bp-authenticated-principal: <x-bp-authenticated-principal>' \
  --header 'x-bot-id: <x-bot-id>' \
  --header 'Authorization: Bearer <token>'

Response

{}