Skip to main content
PATCH

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/merge-patch+json

Merge-patch payload for team updates. Omitted fields remain unchanged. Explicit null clears leadId, deputyLeadId, and externalId. Use empty lists for memberIds, valueUnitIds, and sprintIds to clear them.

name
string | null
externalId
string | null
leadId
string | null

Lead person id. Resolve via GET /v1/public/people.

Example:

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

deputyLeadId
string | null

Deputy lead person id. Resolve via GET /v1/public/people.

Example:

"5d6b7f5a-41b4-4c1e-a4fb-1dd3d89b5f68"

memberIds
string[] | null

Member person ids. Provide an empty list to clear all members.

valueUnitIds
string[] | null

Value unit ids. Provide an empty list to clear all value units.

sprintIds
string[] | null

Sprint ids. Provide an empty list to clear all sprints.

Response

Team updated

id
string
name
string
externalId
string
leadId
string
leadName
string
deputyLeadId
string
deputyLeadName
string
memberIds
string[]
memberNames
string[]
valueUnitIds
string[]
valueUnitNames
string[]
deleted
boolean
sprintIds
string[]
sprintNames
string[]