Skip to main content
POST
Create a family group

Authorizations

Authorization
string
header
required

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

Body

application/json
groupName
string
required

Name of the new group.

Example:

"Family"

displayName
string

Creator's name shown to group members.

Example:

"Jane"

sharedFields
Creator's initial per-metric sharing selection, same shape as the join payload. Omit to keep the opt-in default (nothing shared, so no other member sees the creator's metrics in GroupView). · object

Per-metric sharing choices for the creator.

Example:

Response

The new group document, including the groupId the other group endpoints take. The caller is already its first admin.