Skip to main content
POST
Remove group members

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

group_id
string
required

ID of the group to remove members from. Get it from id in List workspace groups.

Query Parameters

workspaceId
string
required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Minimum string length: 1

Body

application/json
emails
string[]
required

Emails of the members, 1 to 200.

Required array length: 1 - 200 elements
Example:

Response

The members are no longer in the group.

Confirms the change.

status
string
required

Always success.

Allowed value: "success"
Example:

"success"

message
string
required

Short confirmation. Its wording can change, so don't parse it.

Example:

"Members added to group."