Skip to main content
PATCH
Update organizational unit

Authorizations

X-API-Key
string
header
required

Owner-typed API key (ORGANIZATION, PERSON, VALUE_UNIT). Manage org-scoped lifecycle with /v1/public-api-keys; cross-org governance is restricted to /v1/sys/public-api-keys.

Path Parameters

id
string
required

Body

application/json

Update payload. Resolve typeId first via GET /v1/public/organizational-units/types when changing type. Omit headId/deputyHeadId to keep current role assignments or send null to clear.

name
string | null
description
string | null
externalId
string | null

External identifier used by upstream systems. Omit to keep the current value. Send null to clear.

Example:

"hris-ou-1001"

typeId
string | null

Organizational unit type tag id. Resolve via GET /v1/public/tags/organizational-unit-types. Omit to keep current type.

Example:

"77f8a9e1-6131-4f74-9477-c3dd1f98d352"

parentId
string | null

Parent organizational unit id inside the authenticated organization. Omit to keep current parent.

Example:

"a5ec8a9e-b6a9-4230-9ce9-8db4bb40f6ff"

headId
string | null

Head person id inside the authenticated organization. Omit to keep the current head. Send null to clear the head.

Example:

"2f6db7d4-6e6c-4d4f-90f2-cbaac8441f7b"

deputyHeadId
string | null

Deputy head person id inside the authenticated organization. Omit to keep the current deputy head. Send null to clear the deputy head.

Example:

"7b4f1a91-57cd-4a5e-b1f8-16b5705de95b"

tags
string[] | null

Custom tags for the organizational unit. Omit to keep current tags or send an empty list to clear them.

Example:

Response

Organizational unit updated

id
string
name
string
description
string
externalId
string
parentId
string
parentName
string
typeId
string
typeName
string
headId
string
headName
string
deputyHeadId
string
deputyHeadName
string
tags
object[]
valueUnits
object[]
clients
object[]
hasChildren
boolean