Skip to main content

​
Update Team Member

Update a team member’s role.

​
Endpoint

POST /api/teams/{teamId}/users/{userId}

​
Headers

​
Authorization
string
required
Bearer token for authentication

​
Path Parameters

​
teamId
string
required
Team UUID
​
userId
string
required
User UUID

​
Request Body

​
role
string
required
New role to assign. Must be one of:
  • team-member
  • team-view-only
  • team-manager

​
Response

​
id
string
Team user relationship UUID
​
userId
string
User UUID
​
teamId
string
Team UUID
​
role
string
Updated role
​
updatedAt
string
ISO 8601 timestamp of update

​
Example Request

curl -X POST https://your-umami-instance.com/api/teams/660e8400-e29b-41d4-a716-446655440001/users/bb0e8400-e29b-41d4-a716-446655440006 \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"role": "team-manager"}'

​
Example Response

{
  "id": "cc0e8400-e29b-41d4-a716-446655440007",
  "userId": "bb0e8400-e29b-41d4-a716-446655440006",
  "teamId": "660e8400-e29b-41d4-a716-446655440001",
  "role": "team-manager",
  "updatedAt": "2024-03-15T16:45:00.000Z"
}

​
Role Permissions

RoleView AnalyticsEdit ResourcesManage MembersManage Settings
team-managerYesYesYesYes
team-memberYesYesNoNo
team-view-onlyYesNoNoNo

​
Error Responses

​
400
error
Bad Request - User does not exist on this team
​
401
error
Unauthorized - You must be the owner/manager of this team
​
404
error
Not Found - Team or user does not exist

​
Permissions

Only team owners and managers can update member roles.
Be careful when changing a user’s role to team-view-only as they will lose edit permissions for all team resources.

Build docs developers (and LLMs) love

Get started for freeTalk to us