Nurama Developers

remove_chat_members

Remove users from a member chat.

Mutating tool: it changes data in Nurama. Available only when the key carries the matching scope.

Remove users from a member chat. Removed users lose access immediately but message history is preserved for remaining members. To leave a chat yourself, pass the caller's own userId in memberIds.

Input

PropertyTypeRequiredDescription
chatIdstringyesUUID of the member chat.
memberIdsstring[]yesUUIDs of users to remove. min items 1

JSON Schema

{
  "type": "object",
  "properties": {
    "chatId": {
      "type": "string",
      "description": "UUID of the member chat."
    },
    "memberIds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 1,
      "description": "UUIDs of users to remove."
    }
  },
  "required": [
    "chatId",
    "memberIds"
  ],
  "additionalProperties": false
}

On this page