Workspace members update
PATCH
https://app.sulus.ai/api/workspaces/{workspace}/members/{member}
Change a member's role
Authentication
Send a bearer token created on your dashboard's Developer page:
Authorization: Bearer <YOUR_API_KEY>
Path parameters
workspace
string
Required
Workspace id.
Validation:
UUID of a workspace the caller can accessStored in
workspaces.idmember
integer
Required
Member user id.
Validation:
users.id of a current workspace member (list rows use id = user_id)Stored in
workspace_members.user_idRequest body
role
string
Required
New invitable role.
Validation:
required|string|in:admin,member,viewerStored in
workspace_members.roleErrors
| Status | Meaning | Body |
|---|---|---|
401 |
Missing or invalid bearer token | |
403 |
Feature workspaces not enabled | {"message":"This feature is not enabled for your account. Please contact your administrator.","feature":"workspaces"} |
403 |
Policy denied | {"message":"This action is unauthorized."} |
422 |
Validation failed | {"message":"The given data was invalid.","errors":{"email":["The email field is required."]}} |
422 |
Target is the workspace owner | {"message":"The workspace owner role cannot be changed."} |
Notes
- Owner-only (manageMembers policy).
curl --request PATCH \
--url https://app.sulus.ai/api/workspaces/{workspace}/members/{member} \
--header 'Authorization: Bearer <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
"role": "admin"
}'
import requests
url = "https://app.sulus.ai/api/workspaces/{workspace}/members/{member}"
headers = {"Authorization": "Bearer <YOUR_API_KEY>"}
payload = {
"role": "admin"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
url := "https://app.sulus.ai/api/workspaces/{workspace}/members/{member}"
payload := strings.NewReader(`{
"role": "admin"
}`)
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <YOUR_API_KEY>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
Response
200
{
"message": "Member role updated.",
"data": {
"user_id": 44,
"role": "admin"
}
}
Response — PATCH
/workspaces/{workspace}/members/{member}
200
{
"message": "Member role updated.",
"data": {
"user_id": 44,
"role": "admin"
}
}