Update Workspace

POST/web/v1/workspaces/{workspaceBizId}/update JWT

Updates workspace details. Only non-null fields in the request body are applied.

Required Headers

Header	Example Value	Description
Content-Type	application/json	Request content type
Accept	application/json	Expected response type
X-Client-Hash		Client device fingerprint
Accept-Language	en, zh, zh-Hant, ja, vi	Response language (default: en)
Authorization	Bearer	JWT access token
X-Workspace-Id		Target workspace ID

Request Parameters

Name	Type	Required	In	Description
workspaceBizId	String	Required	path	Business ID of the workspace

Request Body

{
  "workspaceName": "Updated Workspace Name",
  "workspaceTimezone": "America/Los_Angeles"
}

Partial update example (name only, timezone unchanged):

{
  "workspaceName": "Owner Updated Space",
  "workspaceTimezone": null
}

Request Example

{
  "workspaceName": "Updated Name",
  "workspaceTimezone": "America/New_York"
}

Success Response

Status: 200 OK

Success 200

{
  "version": "1.3.0",
  "timestamp": 1709337600000,
  "success": true,
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "WS_INVITE_TEST_001",
    "institutionBizId": "INST_INVITE_TEST_001",
    "entityBizId": null,
    "workspaceName": "Updated Workspace Name",
    "workspaceTimezone": "America/Los_Angeles",
    "workspaceStatus": {
      "value": 10010701,
      "name": "ACTIVE",
      "code": "ACTIVE"
    },
    "workspaceKind": {
      "value": 10010801,
      "name": "LIVE",
      "code": "LIVE"
    },
    "extraData": null,
    "createdAt": "2026-03-22T10:30:00Z",
    "updatedAt": "2026-03-22T11:00:00Z"
  }
}

Error Responses

Unauthorized 401

{
  "success": false,
  "code": "4010",
  "message": "Invalid or expired token"
}

Notes

• Only workspaceName and workspaceTimezone are accepted; extraData is not updatable via this endpoint.
• Fields set to null are skipped (not cleared). The original value is preserved.
• Requires workspace membership and workspace:update permission.