Update Workspace

PUT

/v1/workspaces/{workspaceId}

Update details of an existing workspace.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Body Params application/jsonRequired

Example

{
    "name": "Updated Workspace Name",
    "description": "Updated description for the workspace"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT '/v1/workspaces/' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Updated Workspace Name",
    "description": "Updated description for the workspace"
}'

Responses

🟢200

application/json

Workspace updated successfully

Bodyapplication/json

Example

{
    "status": 200,
    "message": "Workspace updated successfully",
    "data": {
        "id": "wks1",
        "name": "Updated Workspace Name",
        "description": "Updated description for the workspace",
        "updatedAt": "2025-10-04T14:00:00Z"
    }
}

Create New Workspace

Add Billing Details