---
title: "Remove members from a group chat"
method: DELETE
path: "/chat/groups/{chatId}/members"
tags: ["Chat"]
---

# Remove members from a group chat

`DELETE /chat/groups/{chatId}/members`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/chat/groups/{chatId}/members`
- Auth: API key in header `x-api-key`

Removes creators from a `manual` group (`orgCreatorIds` in the request body, up to 500); they lose access to the group at once. Archived creators can be removed too; ids that are not members are ignored. The members of `campaign` and `all` groups follow their roster: editing them returns 400 `MANUAL_ONLY`.

## Path parameters

- `chatId` string, required

## Request body

- object
  - `orgCreatorIds` string[], required: Org creator ids (the `id` of `GET /creators` rows), at most 500

## Response `200`

OK

- object
  - `chatId` string, required
  - `memberCount` integer, required: Creators who can read the group: they joined, or hold a pending invitation
  - `pendingMemberCount` integer, required: Creators on the roster who have not been invited to the platform yet
  - `removedOrgCreatorIds` string[], required: The ids this call removed; creators who were not members are left out

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)