PUT /v1/teams

curl -X PUT "{base_url}/api/v1/teams" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Accounting",
    "teamType": "Group",
    "displayName": "Accounting",
    "description": "Accounting team under Finance",
    "parents": ["4f87a3ea-d798-4509-8c64-5b11f8a96f89"]
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Teams

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a")
team.description = "Updated: Accounting team handling all financial reporting"
team.displayName = "Accounting & Reporting"
updated = Teams.update(team)

print(f"Updated to version {updated.version.root}")

// client is an initialized OpenMetadataClient.
var teamId = "449b5f25-4cbb-42db-8f71-3be2c5cd888a";
var team = client.teams().get(teamId);
team.setDescription("Updated: Accounting team handling all financial reporting");

var updated = client.teams().update(teamId, team);

# Update by ID
curl -X PATCH "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Accounting team handling all financial reporting"},
    {"op": "replace", "path": "/displayName", "value": "Accounting & Reporting"}
  ]'

{
  "id": "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "teamType": "Group",
  "name": "Accounting",
  "fullyQualifiedName": "Accounting",
  "displayName": "Accounting & Reporting",
  "description": "Updated: Accounting team handling all financial reporting",
  "version": 0.2,
  "updatedAt": 1769982623753,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "parents": [
    {
      "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
      "type": "team",
      "name": "Finance",
      "fullyQualifiedName": "Finance",
      "displayName": "Finance",
      "deleted": false
    }
  ],
  "users": [
    {
      "id": "2c4036a5-27d5-4d47-949f-3e8666e9d371",
      "type": "user",
      "name": "andrew_jennings3",
      "fullyQualifiedName": "andrew_jennings3",
      "displayName": "Andrew Jennings",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "domains": [],
  "children": [],
  "policies": []
}

PUT

teams

PUT /v1/teams

curl -X PUT "{base_url}/api/v1/teams" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Accounting",
    "teamType": "Group",
    "displayName": "Accounting",
    "description": "Accounting team under Finance",
    "parents": ["4f87a3ea-d798-4509-8c64-5b11f8a96f89"]
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Teams

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a")
team.description = "Updated: Accounting team handling all financial reporting"
team.displayName = "Accounting & Reporting"
updated = Teams.update(team)

print(f"Updated to version {updated.version.root}")

// client is an initialized OpenMetadataClient.
var teamId = "449b5f25-4cbb-42db-8f71-3be2c5cd888a";
var team = client.teams().get(teamId);
team.setDescription("Updated: Accounting team handling all financial reporting");

var updated = client.teams().update(teamId, team);

# Update by ID
curl -X PATCH "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Accounting team handling all financial reporting"},
    {"op": "replace", "path": "/displayName", "value": "Accounting & Reporting"}
  ]'

{
  "id": "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "teamType": "Group",
  "name": "Accounting",
  "fullyQualifiedName": "Accounting",
  "displayName": "Accounting & Reporting",
  "description": "Updated: Accounting team handling all financial reporting",
  "version": 0.2,
  "updatedAt": 1769982623753,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "parents": [
    {
      "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
      "type": "team",
      "name": "Finance",
      "fullyQualifiedName": "Finance",
      "displayName": "Finance",
      "deleted": false
    }
  ],
  "users": [
    {
      "id": "2c4036a5-27d5-4d47-949f-3e8666e9d371",
      "type": "user",
      "name": "andrew_jennings3",
      "fullyQualifiedName": "andrew_jennings3",
      "displayName": "Andrew Jennings",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "domains": [],
  "children": [],
  "policies": []
}

Update a Team

Create a team or update it if it already exists, using PUT /v1/teams with the full request body. Send the complete definition, not just the fields you want to change. To change only some fields, use PATCH with a JSON Patch array and the application/json-patch+json content type, as shown in the PATCH examples below.

Body Parameters

string

required

Name of the team. Must be unique across all teams.

string

required

Type of team. One of: Group, Department, Division, BusinessUnit, Organization.

string

Human-readable display name for the team.

string

Description of the team in Markdown format.

string

Email address associated with the team.

array

Array of parent team UUIDs, as strings. A team can belong to a parent team in the hierarchy.

boolean

default:"true"

Whether users can join this team without an invitation.

array

Array of owner references (users or teams) to assign as owners of this team.

Show properties

string

UUID of the owner entity.

string

Type of owner entity, for example user, team.

string

Name of the owner entity.

array

Array of policy UUIDs, as strings, to attach to the team.

array

Fully qualified names of the domains to assign for governance purposes.

PUT /v1/teams

curl -X PUT "{base_url}/api/v1/teams" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Accounting",
    "teamType": "Group",
    "displayName": "Accounting",
    "description": "Accounting team under Finance",
    "parents": ["4f87a3ea-d798-4509-8c64-5b11f8a96f89"]
  }'

from metadata.sdk import configure
from metadata.sdk.entities import Teams

configure(
    host="https://your-company.open-metadata.org/api",
    jwt_token="your-jwt-token"
)

# Retrieve, modify, and update
team = Teams.retrieve("449b5f25-4cbb-42db-8f71-3be2c5cd888a")
team.description = "Updated: Accounting team handling all financial reporting"
team.displayName = "Accounting & Reporting"
updated = Teams.update(team)

print(f"Updated to version {updated.version.root}")

// client is an initialized OpenMetadataClient.
var teamId = "449b5f25-4cbb-42db-8f71-3be2c5cd888a";
var team = client.teams().get(teamId);
team.setDescription("Updated: Accounting team handling all financial reporting");

var updated = client.teams().update(teamId, team);

# Update by ID
curl -X PATCH "{base_url}/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a" \
  -H "Authorization: Bearer {access_token}" \
  -H "Content-Type: application/json-patch+json" \
  -d '[
    {"op": "replace", "path": "/description", "value": "Updated: Accounting team handling all financial reporting"},
    {"op": "replace", "path": "/displayName", "value": "Accounting & Reporting"}
  ]'

{
  "id": "449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "teamType": "Group",
  "name": "Accounting",
  "fullyQualifiedName": "Accounting",
  "displayName": "Accounting & Reporting",
  "description": "Updated: Accounting team handling all financial reporting",
  "version": 0.2,
  "updatedAt": 1769982623753,
  "updatedBy": "admin",
  "href": "http://localhost:8585/api/v1/teams/449b5f25-4cbb-42db-8f71-3be2c5cd888a",
  "parents": [
    {
      "id": "4f87a3ea-d798-4509-8c64-5b11f8a96f89",
      "type": "team",
      "name": "Finance",
      "fullyQualifiedName": "Finance",
      "displayName": "Finance",
      "deleted": false
    }
  ],
  "users": [
    {
      "id": "2c4036a5-27d5-4d47-949f-3e8666e9d371",
      "type": "user",
      "name": "andrew_jennings3",
      "fullyQualifiedName": "andrew_jennings3",
      "displayName": "Andrew Jennings",
      "deleted": false
    }
  ],
  "deleted": false,
  "owners": [],
  "domains": [],
  "children": [],
  "policies": []
}

Returns

Returns the updated team object with the new version number.

Response

string

Unique identifier for the team (UUID format).

string

Team name.

string

Fully qualified name (same as name for teams).

string

Updated description.

number

Incremented version number.

Error Handling

Code	Error Type	Description
`400`	`BAD_REQUEST`	Invalid or malformed request body
`401`	`UNAUTHORIZED`	Invalid or missing authentication token
`403`	`FORBIDDEN`	User lacks permission to update this team
`409`	`CONFLICT`	Concurrent modification detected

API Reference

Data Assets

AI Assets

AI SDK

SDK

Discovery

Lineage

Data Contracts

Teams And Users

Data Governance

Data Quality

Alerts

Incidents

Main Concepts

Update a Team

Update a Team

Body Parameters

Returns

Response

Error Handling