RemoveParticipants

[POST] .../v1/chat/removeparticipants

Deletes participants from a chat. Use this method to remove one or more participants from a manageable chat without deleting the chat itself. The request body is required, id must contain the chat UUID and participants must identify the participant entity_type and entity_id values to remove. The current request user needs chat edit permission or chat manage-all permission and the method performs a destructive membership removal that returns row_affected on success. Missing body, missing id or participants, invalid participant identifiers, denied permission, missing chat, linked entity restrictions and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id String Required Chat UUID.
participants Array of ChatParticipantRemove Required Participants to remove.

Request Example

{
  "id": "8cdd646d-dbd0-45c0-8f5b-d90a9b000001",
  "participants": [
    {
      "entity_type": "User",
      "entity_id": 64
    }
  ]
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1
  }
}