---
title: "Update team settings"
method: PATCH
path: "/api/v2/teams/{slug}/"
tags: ["Teams"]
---

# Update team settings

`PATCH /api/v2/teams/{slug}/`

## Request

- Base URL: `https://app.biel.ai`
- URL: `https://app.biel.ai/api/v2/teams/{slug}/`
- Auth: API key in header `Authorization`

Update the team's `name` and/or `slug`. The `slug` in the path must match the team that owns the authenticating API key. Include only the fields you want to change.

**Required permission:** `teams_update`

## Path parameters

- `slug` string, required

## Request body

- TeamUpdate: Mutable fields on a team. All fields are optional; include only what you want to change.
  - `name` string: New human-readable team name.
  - `slug` string: New URL slug. Must be unique across all teams.

## Response `200`

Team updated successfully

- Team: A team groups users, projects, and API keys. Each API key is scoped to exactly one team.
  - `id` integer, required: Numeric team id.
  - `name` string, required: Human-readable team name.
  - `slug` string, required: URL slug used to address the team.
  - `members` TeamMember[], required: Active team members.
    - `id` integer, required: Membership id (not the user id).
    - `user_id` integer, required: Underlying user id.
    - `first_name` string, nullable: Member first name.
    - `last_name` string, nullable: Member last name.
    - `display_name` string, required: Display name (full name when available, otherwise email).
    - `role` 'admin' | 'maintainer' | 'editor' | 'viewer', required: Member role in the team.
  - `dashboard_url` string, uri, required: Web URL to the team dashboard.
  - `subscription` TeamSubscription, required: Subscription state of the team.
    - `status` 'active' | 'trialing' | 'none', required: Whether the team has an active paid subscription, is on the free trial, or has neither.
    - `plan` string, nullable, required: Slug of the active plan (for example `professional`), or `null` without a paid subscription.
  - `trial` TeamTrial, required: Free-trial state of the team.
    - `active` boolean, required: Whether the free trial is currently active.
    - `ends_at` string, date-time, nullable, required: ISO-8601 end of the trial window while trialing, otherwise `null`.

## Other responses

- `400`: Validation error. Field-level errors keyed by field name.
- `403`: Forbidden. Missing permissions.
- `404`: Resource not found.

---

[API](https://skmtc.dev/biel/apis/biel-ai-api.md) · [All operations](https://skmtc.dev/biel/apis/biel-ai-api/llms.txt) · [OpenAPI document](https://skmtc.dev/biel/apis/biel-ai-api/revisions/ac7034d82696?raw)