Update a member
⚠️
Preview — this feature is being built; the design below is the spec.
POST https://app.syntic.ai/v1/organizations/users/{user_id}Change a member’s role, or suspend and restore them. The rules match the Console: an Administrator’s key can change developer and custom members (including promoting them to administrator); changing another Administrator needs an Owner’s key. Suspending makes the member’s inference keys fail with 403 org_membership_required at once; restoring brings them back.
For how this fits into a full workflow, see Members.
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 |
|---|---|---|
user_id | string | The member’s id, starting with user_. |
Body parameters
| Parameter | Type | Required | Notes |
|---|---|---|---|
role | string | No | administrator, developer or custom. Owner roles cannot be granted here. |
custom_group_ids | array of strings | With custom | Groups whose permission grids apply. |
status | string | No | active or suspended. |
Response
200 OK, Content-Type: application/json
{
"id": "user_01J9Y0A2C4E6G8J0L2N4",
"type": "user",
"email": "dana@example.com",
"name": "Dana Lee",
"role": "administrator",
"status": "active",
"mfa_enabled": true,
"workspaces": [
{
"workspace_id": "wrkspc_01JC0A2C4E6G8J0L2N4Q",
"role": "workspace_developer"
}
],
"api_key_count": 3,
"joined_at": "2026-02-10T14:00:00Z",
"last_active_at": "2026-11-05T08:41:00Z"
}Examples
curl -sS https://app.syntic.ai/v1/organizations/users/user_01J9Y0A2C4E6G8J0L2N4 \
-H "Authorization: Bearer $SYNTIC_ADMIN_KEY" \
-H "syntic-beta: admin-2026-11-01" \
-H "Content-Type: application/json" \
-d '{
"role": "administrator"
}'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 role, or an owner role requested. |
| 400 | invalid_request_error | custom_groups_required | role: "custom" without groups. |
| 403 | permission_error | role_required | The admin key’s creator does not have the role this needs. |
| 403 | permission_error | owner_protected | Owners and the primary owner cannot be suspended, demoted or removed through the API. |
| 404 | not_found_error | user_not_found | No such person in this organization (or, for workspace calls, in this workspace). |
| 409 | conflict_error | managed_by_directory_sync | The member is managed by directory sync; change them in your identity provider. |
| 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?