curl --request POST \
  --url https://web-api.soxai.site/api/groups/join \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupId": "group_123",
  "code": "ABC123",
  "displayName": "Jane",
  "sharedFields": {
    "sleep_score": true
  }
}
'

import requests

url = "https://web-api.soxai.site/api/groups/join"

payload = {
    "groupId": "group_123",
    "code": "ABC123",
    "displayName": "Jane",
    "sharedFields": { "sleep_score": True }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    groupId: 'group_123',
    code: 'ABC123',
    displayName: 'Jane',
    sharedFields: {sleep_score: true}
  })
};

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

{
  "uid": "user456",
  "groupId": "b7d1f0c9a2e4d6f8b0c1",
  "role": "member",
  "status": "active",
  "displayName": "Dad",
  "joinedAt": "2026-08-03T09:30:00+00:00",
  "masterHidden": false,
  "sharedFields": {
    "sleep_score": true,
    "health_score": true,
    "activity_score": false,
    "sleep_total_time_exclude_awake": false,
    "activity_steps": true,
    "heat_stroke_severity": true,
    "last_sync_time": true
  },
  "sharingScope": "group_only",
  "alreadyJoined": false
}

{
  "error": "bad-request",
  "error_msg": "displayName 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": "conflict",
  "error_msg": "invite code is expired"
}

{
  "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>"
}