AddParticipant

[POST] .../v1/chat/addparticipant

Adds one participant to a chat. Use this method for incremental participant management when a client needs to add one User, Client or supported participant without resending the full list. The request body is required, chat_id must identify the chat and participant must include entity_type, entity_id and role. The current request user needs chat edit permission or chat manage-all permission and linked entity chats may require participant management through the owning entity workflow. Missing body, missing chat_id or participant, invalid role or participant entity, denied permission, missing chat, linked entity restrictions and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
chat_id String Required Chat UUID.
participant ChatParticipantAddEdit Required Participant to add.

Request Example

{
  "chat_id": "8cdd646d-dbd0-45c0-8f5b-d90a9b000001",
  "participant": {
    "entity_type": "User",
    "entity_id": 64,
    "role": "Member"
  }
}

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
  }
}