Skip to main content
PATCH
Rename a team

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

team
string
required

The team UUID

Example:

"fbb31f5f-bd6f-4019-a3ed-1062a28f56f7"

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

name
string
required

The name shown to customers.

Required string length: 1 - 191
Pattern: ^[^\p{C}]+$

Response

The record, as a JSON object. There is no envelope.

A team and the current account's membership details.

id
string
required

The id ID.

Example:

"fbb31f5f-bd6f-4019-a3ed-1062a28f56f7"

name
string
required

The name shown to customers.

Example:

"Anomalous Materials"

is_owner
boolean
required

Whether the resource is owner.

Example:

true

is_default
boolean
required

Where a resource lands when nothing has said otherwise, and the team a session falls back to. Exactly one of an account's teams carries it, which the database enforces rather than trusts.

Example:

true

is_active
boolean
required

Which team the browser is currently working in, compared against the id the resolver settled on rather than against the raw session key. An account may own several teams, so "the one you own" stopped being an answer the moment the session key was empty - every one of them would have read as active at once.

Example:

true

owner
TeamOwnerData · object
required

The value of owner.

Example:
role
TeamRoleSummaryData · object | null
required

The value of role.

Example:

null

permissions
string[]
required

The value of permissions.

Example:
can_leave
boolean
required

Only the owner may leave nothing behind; an owner cannot leave their own account, which is why this is not simply ! is_owner.

Example:

false

members_count
integer | null
required

The number of members count.

Example:

1

held_resources
required

What is still inside the team, so the listing can say it before a deletion is attempted rather than only in the refusal that comes back from one. Both are read from the same method deliberately: a preview that disagreed with the refusal would send somebody looking for a server that is not where they were told it was.

Example:
created_at
string | null
required

Written out with an explicit format rather than left to the date serialiser, because that is what the transformer this replaces published: seconds and an offset, not microseconds and a Z.

Example:

"2025-11-18T21:07:44+00:00"