Teams
Update team name
Rename a team.
PUT /teams/{teamId}/name
Updates the team's display name.
The key holder's role must include Change team settings (Owner, Admin and Deputy Admin include it), and the key holder must have a seat in the team. See the permissions matrix.
Authentication: Bearer token · Permission:
teams:write · Team permission:team_settings.write · Rate limit: default (120 / 60s)Path parameters
teamId
string · uuid v7 required
The ID of the team to rename.
Request body
name
string required
The new team name. 1 to 100 characters.
{ "name": "Acme Marketing" }
Request
curl -X PUT https://api.twominutereports.com/v1/teams/0190f8b0-1a2b-7c3d-8e4f-5a6b7c8d9e0f/name \
-H "Authorization: Bearer tmrc_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{ "name": "Acme Marketing" }'
Response
{
"success": true,
"data": { "name": "Acme Marketing" }
}
{
"success": false,
"error": { "code": "BAD_REQUEST", "message": "Validation error: Enter a team name. at \"name\"" }
}
{
"success": false,
"error": { "code": "PAYMENT_REQUIRED", "message": "Your team's plan has been cancelled. Please reactivate your subscription to continue." }
}
{
"success": false,
"error": { "code": "INSUFFICIENT_ROLE", "message": "[email protected] is not allowed to use team_settings.write. This needs a role that includes it; their role is viewer." }
}
{
"success": false,
"error": { "code": "NOT_FOUND", "message": "Team not found" }
}