Skip to main content
PUT
Update team member
This v1 endpoint is deprecated and will be removed in the coming weeks. Use PATCH /teams/{team_id}/members/{member_id} in the v2 API instead. Note that the v2 equivalent is a PATCH, not a PUT. The v2 path parameter is member_id, not user_role_id.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

team_id
string<uuid>
required

The ID of the team

user_role_id
string<uuid>
required

The ID of the team membership (UserRole ID)

organization_id
string
required

Body

application/json

The updated member data

role
enum<string>
required

New role for the member (editor or viewer)

Available options:
admin,
editor,
viewer

Response

Successful Response

A member of a team (user or SSO group).

id
string<uuid>
required

The unique identifier of this membership (UserRole ID)

type
enum<string>
required

Type of member - either a user or an SSO group

Available options:
user,
sso_group
identifier
string
required

Email address for users, group name for SSO groups

role
enum<string>
required

The role this member has within the team context (editor or viewer)

Available options:
admin,
editor,
viewer
added_at
string<date-time>
required

When the member was added to the team