Chat

Remove members from a group chat

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.

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

Path parameters

chatIdstring required

Request body

orgCreatorIdsstring[] required

Org creator ids (the id of GET /creators rows), at most 500

Response

OK

chatIdstring required
memberCountinteger required

Creators who can read the group: they joined, or hold a pending invitation

pendingMemberCountinteger required

Creators on the roster who have not been invited to the platform yet

removedOrgCreatorIdsstring[] required

The ids this call removed; creators who were not members are left out

Changes

No recorded changes to this operation across all 1 revision of this API.