Join

[POST] .../v1/chat/join

Adds the current user to a channel as a Member participant. Use this method when the current request user joins a channel that is available for self-service membership. The request body is required and id must contain the channel chat UUID; the method inserts or restores the current user's Member participant row and returns row_affected with the affected chat id. Access is scoped to the current user and the target chat must be a channel that accepts member joins. Missing body, missing id, missing or closed channel, already incompatible participant state, unsupported chat type and database failures are returned as HTTP 200 ErrorResult business errors.

Request Parameters

Name Type Required Description
id String Required Channel UUID.

Request Example

{
  "id": "ab91d912-681e-4d6f-9e54-49b23a000001"
}

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,
    "ids": [
      "8cdd646d-dbd0-45c0-8f5b-d90a9b000001"
    ]
  }
}