create Family With Id
POST {{baseUrl}}/api/user/family/:familyId
Creates a family with the user Id in the request as the owner and sole member of the family. You can optionally specify an Id for the family, if not provided one will be generated.
Request Body
{"familyMember"=>{"insertInstant"=>"<long>", "lastUpdateInstant"=>"<long>", "owner"=>"<boolean>", "role"=>"Adult", "userId"=>"<uuid>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-FusionAuth-TenantId | string | The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"families":[{"members":[{"data":{"sit_323":{}},"insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e","owner":"\u003cboolean\u003e","role":"Adult","userId":"\u003cuuid\u003e"},{"data":{"eu_f":{},"dolor_c6":{}},"insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e","owner":"\u003cboolean\u003e","role":"Child","userId":"\u003cuuid\u003e"}],"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e"},{"members":[{"data":{"velit_8b_":{},"proident8_6":{},"incididuntc3":{}},"insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e","owner":"\u003cboolean\u003e","role":"Adult","userId":"\u003cuuid\u003e"},{"data":{"voluptate_6":{}},"insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e","owner":"\u003cboolean\u003e","role":"Teen","userId":"\u003cuuid\u003e"}],"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e"}],"family":{"members":[{"data":{"sed_f":{},"ipsum7b8":{}},"insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e","owner":"\u003cboolean\u003e","role":"Teen","userId":"\u003cuuid\u003e"},{"data":{"nostrud_0b":{},"cupidatat_a22":{},"adipisicing99":{}},"insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e","owner":"\u003cboolean\u003e","role":"Adult","userId":"\u003cuuid\u003e"}],"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","lastUpdateInstant":"\u003clong\u003e"}}