Skip to content

Update a team's name or description

PATCH
/teams/{id}

Changes a team’s name, its description or both. The slug can’t be changed, and parents are managed with the parent endpoints.

You need to be signed in with teams.admin or system.admin granted globally; a grant within this team isn’t enough. A deleted team, or an id with no team, gets 404.

Send only what you want to change; a field you leave out or send as null stays as it is. name is saved exactly as sent, so it isn’t trimmed and can be empty, and an empty description clears the description. The lengths shown aren’t checked. Every successful request, even {}, updates updated_at.

Nothing checks for edits made in between: when two requests change the same field, the one saved last stands. Teams that list this one as a parent can keep showing its old name until the server next reads them fresh. The change is saved before the response is put together, so a plain-text 500 can arrive after it was saved. A body that can’t be read as JSON, or an id that isn’t a UUID, gets a plain-text 400 before sign-in is checked. No audit entry is recorded.

id
required
string format: uuid

The team’s id.

object
name

The new name, saved exactly as sent, so it can be empty. Leave it out or send null to keep the current one. The limits shown aren’t checked.

string
>= 1 characters <= 200 characters
description

The new description; an empty string clears it. Leave it out or send null to keep the current one. The limit shown isn’t checked.

string
<= 500 characters

The updated team, with its parents.

object
id
required
string format: uuid
slug
required

The team’s short name, unique among this server’s teams. A deleted team keeps its slug.

string
<= 80 characters
Example
aurora-rnd
name
required
string
<= 200 characters
Example
Aurora R&D
description
required
string
<= 500 characters
origin_server_id

The server a copied team came from. Left out for this server’s own teams; nothing in the API creates copies.

string format: uuid
nullable
hero_asset_id

The team’s picture: fetch it from /assets/{hero_asset_id}/variants/col. Left out when the team has no picture you can see, and then clients show the team’s initials.

This is checked on every read, for the person asking. The chosen asset must still be public, filed under the team and not deleted, with a col preview on record for its file; if it’s rated mature, the viewer must own it, have mature content turned on where the instance allows it, or have system.admin. The choice is kept when the picture stops qualifying, so it comes back when it qualifies again. It isn’t shared with other servers.

string format: uuid
nullable
parents

The team’s direct parents. Sent when one team is returned (an empty list if it has none) and left out of lists. Deleted parents aren’t included, though a parent renamed or deleted since the team last changed can still show as it was.

Array<object>
object
parent_id
required
string format: uuid
parent_slug
string
parent_name
string
member_count

How many direct memberships the team has; members of teams below it aren’t counted. Only listTeams sends it.

integer format: int64
content_count

How many assets filed under the team haven’t been deleted. Every one counts, including drafts and assets you can’t open or that are hidden from you as mature, so it can be higher than what the team’s asset list shows you. Posts and collections aren’t counted. Only listTeams sends it.

integer format: int64
created_at
required
string format: date-time
updated_at
required
string format: date-time

Malformed request

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
"error": "authentication required: sign in and retry with a valid session or API token"
}

Authenticated but missing required capabilities

object
error
required

Human-readable error summary

string
Example
the request could not be completed

Resource not found

object
error
required

Human-readable error summary

string
Example
the request could not be completed