Skip to main content
PATCH
Update a team via Admin API

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <credential> using either a Clerk session JWT or a Clerk API key (ak_*). API keys may identify a user (user_*) or organization (org_*) principal and are generated in the Clerk Dashboard under API keys.

Path Parameters

id
string
required

Team id (cuid) or team name within the organization

Body

application/json
name
string
Minimum string length: 1
description
string
visibility
enum<string>
Available options:
PUBLIC,
PRIVATE
defaultCostMetric
enum<string>
Available options:
cost,
effective_cost,
list_cost,
contracted_cost,
unblended_cost,
net_unblended_cost,
amortized_cost,
net_amortized_cost
scope
string

Optional team cost filter as CEL. When set, parses and validates against organization dimensions, then persists as whereClause. On create, writes the initial Default scope. On update, updates the single scope row; if the team has more than one named scope, use the /scopes API instead.

Response

Updated team

id
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
name
string
required
description
string
required
visibility
enum<string>
required
Available options:
PUBLIC,
PRIVATE
defaultCostMetric
enum<string>
required
Available options:
cost,
effective_cost,
list_cost,
contracted_cost,
unblended_cost,
net_unblended_cost,
amortized_cost,
net_amortized_cost
organizationId
string
required
scopes
object[]
required
_count
object
required
members
object[]
required
archivedAt
string<date-time> | null
Last modified on July 24, 2026