Update a workspace member
⚠️
Preview — this feature is being built; the design below is the spec.
PATCH https://app.syntic.ai/v1/organizations/workspaces/{workspace_id}/members/{user_id}Give a workspace member a different workspace role; it applies from their next call.
For how this fits into a full workflow, see Workspaces.
Headers
| Header | Required | Value |
|---|---|---|
Authorization | Yes | Bearer <admin key>: an Admin API key (sk_admin_...). Inference keys are refused with 403 admin_key_required. See Admin API keys. |
syntic-beta | Yes, while in preview | admin-2026-11-01. Without it the call fails with 400 beta_required. See Versioning. |
Content-Type | Yes | application/json |
Path parameters
| Parameter | Type | Description |
|---|---|---|
workspace_id | string | The workspace id, starting with wrkspc_. |
user_id | string | The member’s user id. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
role | string | Yes | workspace_user, workspace_developer or workspace_admin. |
Response
200 OK, Content-Type: application/json
{
"type": "workspace_member",
"workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
"user_id": "user_01J9Y0A2C4E6G8J0L2N4",
"role": "workspace_admin",
"added_at": "2026-11-02T10:00:00Z"
}Examples
curl -sS -X PATCH https://app.syntic.ai/v1/organizations/workspaces/wrkspc_01JC0A2C4E6G8J0L2N4Q/members/user_01J9Y0A2C4E6G8J0L2N4 \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01" \
-H "Content-Type: application/json" \
-d '{
"role": "workspace_admin"
}'Errors
Errors use the error envelope and carry a request_id. Codes specific to this operation:
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request_error | beta_required | The syntic-beta header is missing. |
| 400 | invalid_request_error | invalid_role | Unknown workspace role. |
| 404 | not_found_error | workspace_not_found | No workspace with that id in the organization. |
| 404 | not_found_error | user_not_found | No such person in this organization (or, for workspace calls, in this workspace). |
| 403 | permission_error | role_required | The admin key’s creator does not have the role this needs. |
| 401 | authentication_error | invalid_api_key | The admin key is missing, unknown, revoked or expired. |
| 403 | permission_error | admin_key_required | An inference key was used. |
| 429 | rate_limit_error | rate_limited | Too many requests; wait for Retry-After. See Rate-limit headers. |
Was this page helpful?