Skip to main content
POST
Rename a team for future generations

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Headers

X-As-User
string | null

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Body

application/json

Rename a team by its slug.

The rename remains in effect across subsequent context-document regenerations.

Both old_slug and new_slug must match [a-z0-9-]{1,64}. new_name is optional; omit it to keep the generated display name.

old_slug
string
required

Current team slug.

new_slug
string
required

Replacement slug used in generated file paths.

new_name
string | null

Optional display name override. Omit to use the generated name.

Response

Successful Response

team_overrides
Team Overrides · object
required