Skip to content

Update Self Institution

POST/web/v1/workspaces/{workspaceId}/institutions/self/updateWEB

Updates the institution that the current authenticated user belongs to. Supports partial update -- only non-null fields are modified.

Authentication

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

Request Parameters

Path Parameters

NameTypeRequiredInDescription
workspaceIdstringYespathWorkspace business ID

Request Body

InstitutionUpdateRequest:

NameTypeRequiredInDescription
institutionBizIdstringYesbodyInstitution business ID to update
institutionNamestringNobodyNew institution name (max 126 characters)
institutionDescriptionstringNobodyNew description (max 255 characters)
institutionRemarkstringNobodyNew remark (max 255 characters)
extraConfigobjectNobodyExtra configuration (official profile and social media)

Success Response

Success200
{
  "code": "2000",
  "message": "SUCCESS",
  "data": {
    "bizId": "inst_abc123",
    "institutionName": "My Institution 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

CodeDescription
4000Validation error (missing institutionBizId, field size exceeded)
4010Unauthorized (invalid or missing JWT token)
4040Institution not found or user does not belong to this institution

Notes

  • The user can only update their own institution.
  • Only fields provided in the request body are updated; omitted fields remain unchanged.

Internal Documentation