Update Institution

POST/web/v1/workspaces/{workspaceId}/institutions/update WEB

Updates an existing institution. Only non-null fields in the request body are updated (partial update).

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

Request Body

InstitutionUpdateRequest:

Name	Type	Required	In	Description
institutionBizId	string	Required	body	Institution business ID to update
institutionName	string	Optional	body	New institution name (max 126 characters)
institutionDescription	string	Optional	body	New description (max 255 characters)
institutionRemark	string	Optional	body	New remark (max 255 characters)
extraConfig	object	Optional	body	Extra configuration (official profile and social media)

Success Response

Success 200

{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "inst_abc123",
    "institutionName": "Acme Corp Updated",
    "institutionDescription": "Updated description",
    "institutionRemark": null,
    "institutionType": "TENANT",
    "institutionStatus": "ACTIVE",
    "extraConfig": null,
    "createdAt": "2026-03-21T00:00:00Z",
    "updatedAt": "2026-03-21T01:00:00Z"
  }
}

Error Responses

Code	Description
4000	Validation error (missing institutionBizId, field size exceeded)
4010	Unauthorized (invalid or missing JWT token)
4040	Institution not found

Notes

• Only fields provided in the request body are updated; omitted fields remain unchanged.
• At least one updatable field must be provided.