Remove several members from a group

curl --request DELETE \
  --url https://web-api.soxai.site/api/groups/{group_id}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uids": [
    "user_123"
  ]
}
'

import requests

url = "https://web-api.soxai.site/api/groups/{group_id}/members"

payload = { "uids": ["user_123"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({uids: ['user_123']})
};

fetch('https://web-api.soxai.site/api/groups/{group_id}/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success_count": 1,
  "success_uids": [
    "user456"
  ],
  "failed_count": 1,
  "failed_uids": [
    "user789"
  ]
}

{
  "error": "http-error",
  "error_msg": "Invalid authentication credentials. <reason>"
}

{
  "error": "forbidden",
  "error_msg": "Not enough permission"
}

{
  "error": "unprocessable-entity",
  "error_msg": "body.<field>: <validation message>"
}

{
  "error": "rate-limited",
  "error_msg": "Rate limit exceeded. Retry after <n> seconds."
}

{
  "error": "internal-server-error",
  "error_msg": "Failed to fetch data: <error_message>"
}

Family Groups

Remove several members from a group

Remove several members at once — the batch form of DELETE /api/groups/{group_id}/members/{uid}, which stays as-is for clients that remove one member at a time (SOX-64 item 3).

Soft per-uid failure: uids that cannot be removed (an admin, an unknown uid, or the caller — who must use self-leave) come back under failed_uids with their reason while the rest are still removed, so one bad uid does not sink the batch.

Parameters

group_id (path, required) - the group to remove from.
Body (GroupMembersRemove): uids, between 1 and 50 entries.

Response

200 {"success_count", "success_uids", "failed_count", "failed_uids"}. Duplicates collapse to one attempt and first-seen order is kept, so the answer lines up with the request.
A uid that cannot be removed does not sink the batch: it comes back under failed_uids with its reason - an admin, a uid that is not a member, or the caller themselves - while the rest are still removed.

Errors

None beyond the 403 below. Every per-uid failure is folded into the 200, which is what distinguishes this from DELETE /api/groups/{group_id}/members/{uid}: that one answers 400 and 404 for the same conditions.

Authorization

Scheme: Authorization: Bearer <idToken> or soxai-api-key: <api key>.
Authority inside a group comes from the caller’s own membership record, never from a SOXAI role: an Admin, PartnerAdmin or OrgAdmin claim grants nothing here.
Required: the admin role of this group. A non-member receives 403 not a member of this group, and a plain member 403 group admin required.

DELETE

api

groups

{group_id}

members

Remove several members from a group

curl --request DELETE \
  --url https://web-api.soxai.site/api/groups/{group_id}/members \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uids": [
    "user_123"
  ]
}
'

import requests

url = "https://web-api.soxai.site/api/groups/{group_id}/members"

payload = { "uids": ["user_123"] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.delete(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'DELETE',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({uids: ['user_123']})
};

fetch('https://web-api.soxai.site/api/groups/{group_id}/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "success_count": 1,
  "success_uids": [
    "user456"
  ],
  "failed_count": 1,
  "failed_uids": [
    "user789"
  ]
}

{
  "error": "http-error",
  "error_msg": "Invalid authentication credentials. <reason>"
}

{
  "error": "forbidden",
  "error_msg": "Not enough permission"
}

{
  "error": "unprocessable-entity",
  "error_msg": "body.<field>: <validation message>"
}

{
  "error": "rate-limited",
  "error_msg": "Rate limit exceeded. Retry after <n> seconds."
}

{
  "error": "internal-server-error",
  "error_msg": "Failed to fetch data: <error_message>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

group_id

string

required

Group ID.

Example:

"group_123"

Body

application/json

uids

string[]

required

Member user IDs to remove from the group.

Required array length: 1 - 50 elements

Example:

["user_123"]

Response

Per-uid outcome of the batch. A uid that cannot be removed comes back under failed_uids while the rest are still removed.

Get started

API Reference (Sandbox)

API Reference (Production)

About

Remove several members from a group

Authorizations

Path Parameters

Body

Response