Content

Tenants / Create

Creates new tenant.. Tenant in url can be "sys"

Route: /api/sys/v{version:apiVersion}/tenants

Method: POST

Authorisation: Minimum role: USER

Name	Type	Source
input	DTO_tenant_create	Body

Request body example

Response status: 200 (OK)

Response type: DTO_tenant

Other response statuses: 400 (BadRequest), 403 (Forbidden)

Response body example

Name	Type	Description
friendly_name	String	Friendly name
unique_name	String	Unique name
did	String	Did

Name	Type	ReadOnly	Description
language	DTO_translation_language		Language
mailboxes	DTO_reference_mailbox[]		Mailboxes
id	Int32	ReadOnly	Id
friendly_name	String		Friendly name
unique_name	String		Unique name
fqdn	String	ReadOnly	Fqdn
created	DateTime		Created
user_count	Int32	ReadOnly	User count
logo	String	ReadOnly	Logo
plan	ENUM tenant_plan	ReadOnly	Plan
time_zone	String		Time zone

Name	Type	ReadOnly	Description
id	Int32	ReadOnly	Leave empty on input
name	String		Name
code	String		Code
icon	String	ReadOnly	Icon
icon_sqare	String	ReadOnly	Icon sqare

Name	Type	ReadOnly	Description
type	ENUM mailbox_type	ReadOnly	Type
status	ENUM mailbox_status	ReadOnly	Status
id	Int32		Id
label	Object	ReadOnly	Label

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	PLATFORM_PROVIDED	Built in @tenant.deskhero.com
2	DNS	DNS setup / Custom Email domain
3	MICROSOFT	Auth2 Microsoft365 provided
4	GOOGLE	Auth2 Google provided

DELETE Templates / Delete

PUT Tenants / Update