Create Tenant Admin Init
POST
/web/v1/workspaces/{workspaceId}/institutions/{institutionBizId}/admin-initWEBInitiates the tenant admin invitation flow for a given institution. Sends an invitation email to the specified administrator.
Authentication
Requires a valid JWT token. Gateway validation: enableJwtToken=true, enableTurnstile=false.
Request Parameters
Path Parameters
| Name | Type | Required | In | Description |
|---|---|---|---|---|
workspaceId | string | Yes | path | Workspace business ID |
institutionBizId | string | Yes | path | Institution business ID |
Request Body
TenantAdminInitRequest:
| Name | Type | Required | In | Description |
|---|---|---|---|---|
email | string | Yes | body | Admin email address (max 255 characters, must be valid email format) |
name | string | No | body | Admin display name (2-126 characters) |
phone | string | No | body | Admin phone number (E.164 format, max 25 characters) |
Success Response
Success200
{
"code": "2000",
"message": "SUCCESS",
"data": {
"institutionBizId": "inst_abc123",
"email": "admin@example.com",
"sessionId": "sess_xyz789",
"expiresAt": "2026-03-22T00:00:00Z",
"created": true,
"emailSent": true
}
}Error Responses
| Code | Description |
|---|---|
4000 | Validation error (invalid email format, name too short/long) |
4010 | Unauthorized (invalid or missing JWT token) |
4040 | Institution not found |
Notes
- If a pending init record already exists for the same email,
createdwill befalseand the invitation email is resent. - The
sessionIdcan be used to track the initialization flow. - The
expiresAtfield indicates when the session will expire.