Update a Family API
On this page
This API is used to update an existing Family member. You may only update the User's role or owner status.
Request#
OpenAPI Spec
Path Parameters#
familyIdThe unique Id of the Family.
Request Headers#
X-FusionAuth-TenantIdThe unique Id of the tenant used to scope this API request.
The tenant Id is not required on this request even when more than one tenant has been configured because the tenant can be identified based upon other values in the request or it is otherwise not required.
Specify a tenant Id on this request when you want to ensure the request is scoped to a specific tenant. The tenant Id may be provided through this header or by using a tenant locked API key to achieve the same result.
See Making an API request using a Tenant Id for additional information.
Request Body#
familyMember.userId The unique userId of the User to add to a family.
familyMember.owner Set to true to indicate a family owner. This value will be ignored if the user role is Teen or Child.
familyMember.role The role of the user in the family.
The possible values are:AdultChildTeen
{
"familyMember": {
"userId": "b3360a2d-e81d-4314-b9f1-244a916ca52f",
"owner": true,
"role": "Adult"
}
}Response#
The response for this API contains the Family that was updated.
Response Codes| Code | Description |
|---|---|
| 200 | The request was successful. The response will contain a JSON body. |
| 400 | The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present. |
| 401 | You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication. |
| 404 | The object you are trying to update doesn't exist. The response will be empty. |
| 500 | There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty. |
| 503 | The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body. |
Response Body#
family.id The unique Id of the family.
family.insertInstant The instant that the Family was added to the FusionAuth database.
family.lastUpdateInstant The instant that the Family was updated in the FusionAuth database.
family.members The members of this family.
family.members[x].insertInstant The instant when the user was added to the family.
families.members[x].lastUpdateInstant The instant when the family member was last updated.
family.members[x].owner True if this user is the owner of the family, the first Adult user in the family will automatically be set as the owner. A teen or child cannot be the family owner.
family.members[x].role The role of the family member.
The possible values are:AdultChildTeen
family.members[x].userId The unique user Id of the family member.
{
"family": {
"id": "a815b480-d52d-4755-96ac-749c067925d7",
"insertInstant": 1595361142909,
"lastUpdateInstant": 1595361143101,
"members": [
{
"insertInstant": 1562010348111,
"lastUpdateInstant": 1595361143101,
"owner": true,
"role": "Adult",
"userId": "b3360a2d-e81d-4314-b9f1-244a916ca52f"
}
]
}
}Related
API documentation for the FusionAuth Add a User to a Family API.
Learn about the APIs for creating, retrieving, updating and deleting families.
API documentation for the FusionAuth Remove a User from a Family API.
API documentation for the FusionAuth Retrieve a Family API.