Skip to main content
PUT
Add a team member or set their role

Authorizations

Authorization
string
header
required

Workspace API key (wk_). GET endpoints require the Workspace read API scope, POST, PUT, PATCH and DELETE endpoints the Workspace write API scope, and sending or revoking invitations (POST and DELETE /workspaceapi/invites) the Invite members scope. A key stops working when it expires or is disabled.

Path Parameters

teamId
string
required

Team id.

userId
string
required

User id of a workspace member.

Body

application/json
role
enum<string>
required

Team role.

Available options:
admin,
member,
guest

Response

The user was already in the team; their role is now the requested one.

teamId
string
required
userId
string
required
role
enum<string>
required
Available options:
admin,
member,
guest