Skip to content

Update Portal

POST/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/portals/updateWEB

Updates an existing portal entry. Supports partial update.

Authentication

Requires a valid JWT token. Gateway validation: enableJwtToken=true, enableTurnstile=false.

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID
institutionBizIdstringYespathInstitution business ID

Request Body

InstitutionPortalUpdateRequest:

NameTypeRequiredInDescription
institutionPortalIdlongYesbodyPortal record ID to update
domainstringNobodyNew portal domain URL (max 255 characters)
remarkstringNobodyNew remark (max 255 characters)
portalStatusintegerNobodyNew 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

CodeDescription
4000Validation error (missing institutionPortalId)
4010Unauthorized (invalid or missing JWT token)
4040Portal not found

Notes

  • Only non-null fields in the request body are updated.

Internal Documentation