TeamResource

Update a team

Update team settings such as display name, timezone, labels, and engagement report settings.

Required API key permissions

  • Scope: teams:update
  • Accepted key types: organization API key (org-wide), organization API key (team-scoped), personal access token (org-wide), personal access token (team-scoped)
  • Access: Operates on a single organization. Pass organizationId when your API key spans multiple organizations.
  • Organization role (user-linked keys only): Member when the user has an explicit organization membership. Explicit organization membership is not required; team-based access applies and effective access is gated by the required team role.
  • Required team role (user-linked keys only): Administrator
  • Organization API keys are not subject to organization or team role checks.
put/api/public/v1/team/{id}

Request

Path parameters

idstring uuid required

Query parameters

organizationIdstring uuid
provisionboolean

When true, the created or updated resource is marked as provisioned and becomes read-only in the web UI. Defaults to false on create. On update, omitting this parameter preserves the existing provisioned state. Not available for personal access tokens.

Request body

displayNamestring required
timeZoneIdstring required
labelsstring[] nullable

Response

OK

idstring uuid
isProvisionedboolean
displayNamestring nullable
timeZoneIdstring nullable
labelsstring[] nullable

Changes

No recorded changes to this operation across all 1 revision of this API.