Skip to main content
PATCH
Update a unit

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

Unit identifier

Body

application/merge-patch+json

The updated Unit resource

name
string
parent
unknown
logo
string | null
unitType
string<iri-reference> | null
Example:

"/api/v1/unit_types/1"

dateCreated
string<date-time>
dateEnded
string<date-time> | null
status
string | null
default:ACTIVE
userType
string<iri-reference> | null
Example:

"/api/v1/roles/1"

isRoleGroup
boolean | null
emoji
string | null

Response

Unit resource updated

id
integer
read-only
name
string
parent
unknown
logo
string | null
unitType
object | null
dateCreated
string<date-time>
dateEnded
string<date-time> | null
status
string | null
default:ACTIVE
unitRoles
object[]
userType
object | null
localCenter
object | null
isRoleGroup
boolean | null
activeMemberCount
integer
default:0
emoji
string | null