Rename a family group
curl --request PUT \
--url https://web-api.dev.soxai.site/api/groups/{group_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groupName": "Family"
}
'import requests
url = "https://web-api.dev.soxai.site/api/groups/{group_id}"
payload = { "groupName": "Family" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({groupName: 'Family'})
};
fetch('https://web-api.dev.soxai.site/api/groups/{group_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"groupId": "b7d1f0c9a2e4d6f8b0c1",
"groupName": "Shibata family",
"groupType": "family",
"createdBy": "user123",
"createdAt": "2026-08-03T09:30:00+00:00",
"status": "active"
}{
"error": "bad-request",
"error_msg": "groupName must not be empty"
}{
"error": "http-error",
"error_msg": "Invalid authentication credentials. <reason>"
}{
"error": "forbidden",
"error_msg": "Not enough permission"
}{
"error": "not-found",
"error_msg": "group 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
Rename a family group
Not callable with a Sandbox key
A request authenticated with a Sandbox soxai-api-key is answered 403 This endpoint is not available in the sandbox., because it changes state that every Sandbox caller shares. It is published here because the Sandbox runs the same build; use it in Production. See Sandbox.
Rename a group.
Parameters
group_id(path, required) - the group to rename.- Body (
GroupUpdate):groupName, which must not be empty.
Response
200returns the group document as it now stands.
Errors
| Status | Condition |
|---|---|
| 400 | groupName is empty |
| 404 | The group does not exist |
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.
PUT
/
api
/
groups
/
{group_id}
Rename a family group
curl --request PUT \
--url https://web-api.dev.soxai.site/api/groups/{group_id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"groupName": "Family"
}
'import requests
url = "https://web-api.dev.soxai.site/api/groups/{group_id}"
payload = { "groupName": "Family" }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({groupName: 'Family'})
};
fetch('https://web-api.dev.soxai.site/api/groups/{group_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"groupId": "b7d1f0c9a2e4d6f8b0c1",
"groupName": "Shibata family",
"groupType": "family",
"createdBy": "user123",
"createdAt": "2026-08-03T09:30:00+00:00",
"status": "active"
}{
"error": "bad-request",
"error_msg": "groupName must not be empty"
}{
"error": "http-error",
"error_msg": "Invalid authentication credentials. <reason>"
}{
"error": "forbidden",
"error_msg": "Not enough permission"
}{
"error": "not-found",
"error_msg": "group 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
Response
The group document as it now stands.