Revoke Portal
POST
/web/v1/system/institutions/portals/revoke WEBRequired Gateway Headers
All API requests require gateway headers. See Required Headers for the complete list. In local/test environments, you must also include Cloudflare simulation headers (CF-Connecting-IP, Cf-Ray, cf-ipcountry).
Revokes (disables) a specific portal entry for an 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 |
institutionPortalId | long | Required | path | Portal record ID to revoke |
Success Response
Success 200
{
"code": "2000",
"message": "SUCCESS",
"data": null
}Error Responses
| Code | Description |
|---|---|
4010 | Unauthorized (invalid or missing JWT token) |
4040 | Portal not found |
Notes
- This operation is irreversible. The portal will be marked as disabled.