Skip to main content
PATCH
/
organizations
/
{organization_name}
/
teams
/
{team_slug}
Update an organization team
curl --request PATCH \
  --url https://api.planetscale.com/v1/organizations/{organization_name}/teams/{team_slug} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>"
}'
{
  "id": "<string>",
  "display_name": "<string>",
  "creator": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  },
  "members": [
    {
      "id": "<string>",
      "display_name": "<string>",
      "name": "<string>",
      "email": "<string>",
      "avatar_url": "<string>",
      "created_at": "<string>",
      "updated_at": "<string>",
      "two_factor_auth_configured": true,
      "default_organization": {
        "id": "<string>",
        "name": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "deleted_at": "<string>"
      },
      "sso": true,
      "managed": true,
      "directory_managed": true,
      "email_verified": true
    }
  ],
  "databases": [
    {
      "id": "<string>",
      "name": "<string>",
      "url": "<string>",
      "branches_url": "<string>"
    }
  ],
  "name": "<string>",
  "slug": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "description": "<string>",
  "managed": true
}

Authorizations

Authorization
string
header
required

Path Parameters

organization_name
string
required

The name of the organization

team_slug
string
required

The slug of the team

Body

application/json
name
string

The new name for the team

description
string

The new description for the team

Response

Returns the updated team. Note: SSO-managed teams cannot be updated.

id
string
required

The ID of the team

display_name
string
required

The display name of the team

creator
object
required
members
object[]
required
databases
object[]
required
name
string
required

The name of the team

slug
string
required

The slug of the team

created_at
string
required

When the team was created

updated_at
string
required

When the team was last updated

description
string
required

The description of the team

managed
boolean
required

Whether the team is managed through SSO/directory services