Skip to main content
PUT
Update workspace member role

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>.

Path Parameters

email
string
required

Email of the member whose role to change, exactly as email in List workspace members returns it. Matching is exact, including case. URL-encode it: @ as %40 and + as %2B.

Query Parameters

workspaceId
string
required

ID of the workspace. With a personal access token, use the token's workspace. Get it from organization_id in Get app.

Minimum string length: 1

Body

application/json

A member's new role.

role
enum<string>
required

The member's new role. admin needs the Business plan or higher.

Available options:
admin,
editor,
viewer
Example:

"editor"

Response

The member has the new role.

Confirms the change.

status
string
required

Always success.

Allowed value: "success"
Example:

"success"

message
string
required

Short confirmation. Its wording can change, so don't parse it.

Example:

"Members added to group."