Update Portal
POST
/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/portals/updateWEBUpdates an existing portal entry. Supports partial update.
Authentication
Requires a valid JWT token. Gateway validation: enableJwtToken=true, enableTurnstile=false.
Request Parameters
Path Parameters
| Name | Type | Required | In | Description |
|---|---|---|---|---|
workspaceId | string | Yes | path | Workspace business ID |
institutionBizId | string | Yes | path | Institution business ID |
Request Body
InstitutionPortalUpdateRequest:
| Name | Type | Required | In | Description |
|---|---|---|---|---|
institutionPortalId | long | Yes | body | Portal record ID to update |
domain | string | No | body | New portal domain URL (max 255 characters) |
remark | string | No | body | New remark (max 255 characters) |
portalStatus | integer | No | body | New portal status code |
Success Response
Success200
{
"code": "2000",
"message": "SUCCESS",
"data": {
"id": 1,
"institutionBizId": "inst_abc123",
"portalType": 10010102,
"domain": "https://new-tenant.example.com",
"portalStatus": 10080101,
"remark": "Updated remark",
"createdAt": "2026-03-21T00:00:00Z",
"updatedAt": "2026-03-21T01:00:00Z"
}
}Error Responses
| Code | Description |
|---|---|
4000 | Validation error (missing institutionPortalId) |
4010 | Unauthorized (invalid or missing JWT token) |
4040 | Portal not found |
Notes
- Only non-null fields in the request body are updated.