# Tenant detail & branding

Review tenant schools, subscription and quotas and maintain supported branding.

Category: Platform
Guide: https://avkul.in/docs/guides/screen-saas-tenants-id-detail/
Guided sample demo: https://avkul.in/docs/demo/screen-saas-tenants-id-detail/
Snapshot: 11 October 2026

## Features

- School list
- Subscription and counts
- Branding
- Domain settings
- Additional schools

## Access and setup

Intended access: Platform administrator
- Platform administrator access.
- Choose the relevant school, academic session or child before working.


## Workflow

1. Open the tenant from the list.
2. Review its schools and subscription.
3. Save approved branding or add a school within quota.
4. Verify domain setup separately before relying on it.

## Fields and controls

- code (string, declared required)
- name (string, declared required)
- type (string, optional)
- board (string, optional)
- adminEmail (string, optional)
- adminPassword (string, optional)
- adminFirstName (string, optional)
- adminLastName (string, optional)
- brandName (string, optional)
- primaryColor (string, optional)
- faviconUrl (string, optional)
- domain (string, declared required)

## Current limits

- Platform access is distinct from a school role. Online SaaS invoice collection and invitation delivery require configured providers.

## Actual application access

- https://avkul.in/en/saas/tenants — select the actual record from this list.

## API reference

- GET /api/v1/saas/tenants/:id — Tenant detail with schools, subscription and counts; Platform admin
- POST /api/v1/saas/tenants/:id/schools — Add a school to an existing tenant (counts against the plan); Platform admin
- PATCH /api/v1/saas/tenants/:id/branding — Update white-label branding (brand name, color, custom domain); Platform admin
- POST /api/v1/saas/tenants/:id/domain — Claim a custom domain — returns a DNS TXT record to publish for ownership proof; Platform admin
- DELETE /api/v1/saas/tenants/:id/domain — Remove the custom domain and reset verification; Platform admin
- POST /api/v1/saas/tenants/:id/domain/verify — Verify domain ownership via a real DNS TXT lookup; Platform admin

## Demo access

No login is required for the guided sample demo. Its fictional records and actions stay in this browser tab; they do not modify ERP records or send messages/payments. An assigned account is required for the actual ERP links.

Source inventory checked on 11 October 2026. This source inventory is not a certification of every external provider or device flow.