Skip to main content
PATCH
Update family name

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Path Parameters

id
string
required

FamilyEntity identifier

Body

application/merge-patch+json

The updated FamilyEntity resource

name
string
familyOwner
string<iri-reference> | null
Example:

"/api/v1/users/1"

tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

member
string<iri-reference>[]
write-only
Example:

Response

FamilyEntity resource updated

id
integer
read-only
name
string
familyOwner
object | null
dateCreated
string<date-time>
dateUpdated
string<date-time>