Organization

Update a team

Partial update of a team. Only nodes of the business unit kind can be edited this way.

Required scope organisation:edit

patch/teams/{id}

Authorizations

Authorizationstringrequired

Authorization header carrying a workspace API key, as “Bearer kbn_live_…”. The X-Api-Key header is accepted equivalently.

Path parameters

idstring<uuid>required

Identifier of the team.

Bodyapplication/json

namestring

Name of the team.

descriptionstring

Free-text description of the team.

iconstring

Icon of the team.

Response200 · application/json

The updated team record.

idstring<uuid>required

Identifier of the team.

namestringrequired

Name of the team.

typestringrequired

Kind of node: an organization or a business unit.

descriptionstring | null

Free-text description of the team.

iconstring | null

Icon of the team.

parentOrganizationIdstring<uuid> | null

Parent node in the organization tree.

createdAtstring<date-time>

Timestamp the team was created.

updatedAtstring<date-time>

Timestamp of the last change.