Remove one member from a group
curl --request DELETE \
--url https://web-api.soxai.site/api/groups/{group_id}/members/{uid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://web-api.soxai.site/api/groups/{group_id}/members/{uid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://web-api.soxai.site/api/groups/{group_id}/members/{uid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"removed": true
}{
"error": "bad-request",
"error_msg": "cannot remove an admin"
}{
"error": "http-error",
"error_msg": "Invalid authentication credentials. <reason>"
}{
"error": "forbidden",
"error_msg": "Not enough permission"
}{
"error": "not-found",
"error_msg": "member not found"
}{
"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 one member from a group
Remove a single member from a group’s roster.
An admin is never removable directly - demote them to member first with
PUT /api/groups/{group_id}/members/{uid}/role. The caller cannot remove itself either; use
DELETE /api/groups/{group_id}/members/me.
Parameters
group_id(path, required) - the group to remove from.uid(path, required) - the member to remove.
Response
200reports the removal. The member loses the group immediately; nothing else of theirs is touched.
Errors
| Status | Condition |
|---|---|
| 400 | uid is the caller, or names a member holding the admin role |
| 404 | uid is not on this group’s roster |
Authorization
- Scheme:
Authorization: Bearer <idToken>orsoxai-api-key: <api key>. - Authority inside a group comes from the caller’s own membership record, never from a SOXAI
role: an
Admin,PartnerAdminorOrgAdminclaim grants nothing here. - Required: the
adminrole of this group. A non-member receives403 not a member of this group, and a plain member403 group admin required.
DELETE
/
api
/
groups
/
{group_id}
/
members
/
{uid}
Remove one member from a group
curl --request DELETE \
--url https://web-api.soxai.site/api/groups/{group_id}/members/{uid} \
--header 'Authorization: Bearer <token>'import requests
url = "https://web-api.soxai.site/api/groups/{group_id}/members/{uid}"
headers = {"Authorization": "Bearer <token>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};
fetch('https://web-api.soxai.site/api/groups/{group_id}/members/{uid}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"removed": true
}{
"error": "bad-request",
"error_msg": "cannot remove an admin"
}{
"error": "http-error",
"error_msg": "Invalid authentication credentials. <reason>"
}{
"error": "forbidden",
"error_msg": "Not enough permission"
}{
"error": "not-found",
"error_msg": "member not found"
}{
"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
HTTPBearerSoxaiApiKey
Path Parameters
Response
The member has lost the group. Nothing else of theirs is touched.