v20

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-011984401.2 MB
My Teams

Update a team

Updates a team's profile fields. The caller (key owner) must be the team captain. Requires teams.profile:read-write.

patch/teams/{identifier}

Path parameters

identifierstring required

Team slug or Convex team ID.

Team slug or Convex team ID.

Request body

namestring
tagstring
descriptionstring
platformstring
region'NONE' | 'NA_EAST' | 'NA_WEST' | 'EU' | 'ASIA' | 'OCEANIA' | 'SOUTH_AMERICA' | 'MIDDLE_EAST' | 'AFRICA'
profileVisibility'public' | 'limited' | 'private'

Response

Team updated.

successtrue required
timestampstring required

Response generation time (ISO 8601).