Update Workspace

Developing

Develop Env

http://localhost:3000/api

PUT

/workspaces/{workspace_id}

Maintainer:Suhaib Ghattass

Purpose
Update workspace metadata, settings, or feature flags. Used by admins to reconfigure a team space or enable exam tools for a course.

Auth / Scope
User must have workspace:update permission in the workspace (typically admin or owner role).

Headers
Content-Type: application/json
Authorization: Bearer <USER_JWT>
Idempotency-Key: (recommended)
Idempotency & retries
Same key → returns same result or 409 if concurrent modification.

Rate limits
10 updates/minute per workspace.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200Success

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'http://localhost:3000/api/workspaces/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "CS101: AI Fundamentals (Updated)",
    "description": "Updated syllabus for Fall 2025",
    "settings": {
        "examGenerationEnabled": true,
        "beginnerModeDefault": false
    },
    "featureFlags": {
        "aiAttendee": true
    },
    "allowedDomains": [
        "university.edu",
        "guests.university.edu"
    ]
}'

Response Example

{
    "message": "Workspace updated successfully",
    "data": {
        "workspaceId": "w-7d8e9f0a-...",
        "name": "CS101: AI Fundamentals (Updated)",
        "settings": { ...
        },
        "updatedAt": "2025-10-22T16:30:00Z"
    }
}

Modified at 2025-10-22 21:43:01

Get Workspace

Delete Workspace