POST Update Workspace endpoint.
Endpoint
POST
/web/v1/system/workspaces/admin/update WEBAuthentication
- Chain: WEB
- JWT Token: true
- API Key: false
- Permissions: ["platform:workspace:write"]
Rate Limit
Standard rate limit applies.
Headers
Frontend Headers
| Header | Required | Description |
|---|---|---|
| X-LOCALE | Yes | 用户的 locale |
| Accept-Language | No | 语言偏好 |
Cloudflare Headers
| Header | Required | Description |
|---|---|---|
| CF-Connecting-IP | Yes | Client IP from Cloudflare |
| CF-IPCountry | Yes | Client country code |
| CF-Ray | Yes | Cloudflare Ray ID |
| CF-Visitor | Yes | Visitor scheme |
| CF-Worker | No | Cloudflare Worker indicator |
| CF-TCP-Port | No | Client TCP port |
| CF-Edge-Keep-Alive | No | Edge keep-alive status |
| CF-Cache-Status | No | Cache status |
| CDN-Loop | No | CDN loop detection |
| X-Real-IP | Yes | Real client IP |
Nginx Headers
| Header | Required | Description |
|---|---|---|
| X-PORTAL-ACCESS-CODE | Yes | Portal access code |
| X-Real-IP | Yes | 客户端真实 IP |
| X-Forwarded-For | Yes | 代理链 |
| X-Forwarded-Proto | Yes | 协议 |
Request Parameters
Body (JSON)
| Field | Type | Required | Description |
|---|---|---|---|
| targetWorkspaceBizId | String | Yes | target workspace business ID |
| workspaceName | String | No | workspace name |
| workspaceTimezone | String | No | workspace timezone |
Response
200 OK
| Field | Type | Description |
|---|---|---|
| data.bizId | String | 业务 ID |
| data.institutionBizId | String | 机构业务 ID |
| data.entityBizId | String | 实体业务 ID |
| data.workspaceName | String | 工作空间名称 |
| data.workspaceTimezone | String | 工作空间时区 |
| data.workspaceStatus | UserWorkspaceStatus | 工作空间状态 |
| data.workspaceKind | WorkspaceKind | 工作空间类型 |
| data.extraData | String | 扩展数据 |
| data.createdAt | Instant | 创建时间 |
| data.updatedAt | Instant | 更新时间 |