Skip to main content
PATCH
Update a tenant

Authorizations

Authorization
string
header
required

Use JWT token for authentication

Path Parameters

tenantId
string
required

tenantId

Body

application/json

Editable tenant fields. Setting imageUrl or domain marks them manual and freezes the automatic favicon/domain detection.

displayName
string
email
string
imageUrl
string

Overrides the auto-detected favicon (marks it manual)

domain
string

Overrides domain auto-detection (marks it manual)

Response

Updated tenant

_id
string
tenantId
string

Account-chosen identifier of the tenant

displayName
string
email
string
imageUrl
string

Logo URL (auto favicon of the corporate domain, or manual)

domain
string

Corporate domain (auto-detected or manual)

source
string

How the tenant was created (e.g. auto)

subtenantsCount
integer
firstSeenAt
string<date-time>
lastSeenAt
string<date-time>
metadata
object