更新工作空间
POST
/web/v1/workspaces/{workspaceBizId}/update JWT更新工作空间详情。仅请求体中非 null 的字段会被应用。
鉴权
Auth Chain: WEB Chain — 需要
Authorization: Bearer <jwt>系统注入的请求头(前端无需处理):X-PORTAL-ACCESS-CODE(Nginx)、X-Request-Id(Gateway)
请求参数
| Name | Type | Required | In | Description |
|---|---|---|---|---|
workspaceBizId | String | Required | path | 工作空间业务 ID |
请求体
json
{
"workspaceName": "更新后的工作空间",
"workspaceTimezone": "America/Los_Angeles"
}仅更新名称的示例(时区不变):
json
{
"workspaceName": "所有者更新空间",
"workspaceTimezone": null
}请求示例
json
{
"workspaceName": "Updated Name",
"workspaceTimezone": "America/New_York"
}成功响应
状态码: 200 OK
成功 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": "更新后的工作空间",
"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"
}
}错误响应
未授权 401
{
"success": false,
"code": "4010",
"message": "Invalid or expired token"
}说明
- 仅接受
workspaceName和workspaceTimezone;extraData不可通过此接口更新。 - 设置为
null的字段会被跳过(不会清除),保留原始值。 - 需要工作空间成员身份和
workspace:update权限。