Create Portal
POST
/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/portals WEBCreates a new portal entry for the specified institution.
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 |
Request Parameters
Path Parameters
| Name | Type | Required | In | Description |
|---|---|---|---|---|
workspaceId | string | Required | path | Workspace business ID |
institutionBizId | string | Required | path | Institution business ID |
Request Body
InstitutionPortalCreateRequest:
| Name | Type | Required | In | Description |
|---|---|---|---|---|
portalType | integer | Required | body | Portal type code (e.g., 10010101=system, 10010102=tenant, 10010103=partner, 10010104=consumer) |
domain | string | Required | body | Portal domain URL (max 255 characters) |
remark | string | Optional | body | Portal remark (max 255 characters) |
Success Response
Success 200
{
"code": "2000",
"message": "SUCCESS",
"data": {
"id": 1,
"institutionBizId": "inst_abc123",
"portalType": 10010102,
"domain": "https://tenant.example.com",
"portalStatus": 10080101,
"remark": null,
"createdAt": "2026-03-21T00:00:00Z",
"updatedAt": "2026-03-21T00:00:00Z"
}
}Error Responses
| Code | Description |
|---|---|
4000 | Validation error (missing portalType or domain) |
4010 | Unauthorized (invalid or missing JWT token) |
4040 | Institution not found |
Notes
- Portal status is set to ACTIVE by default upon creation.