Content

Organizations / Update

Update an existing organization (admin only). Roles per user are set via role_enum_id in tenant_users.

Route: /api/sys/v{version:apiVersion}/organizations/{id}

Method: PUT

Authorisation: Minimum role: ADMIN

Name	Type	Source
id	Int32
input	DTO_tenant	Body

Request body example

Response status: 200 (OK)

Response type: DTO_tenant

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

Response body example

Name	Type	ReadOnly	Description
language	DTO_translation_language		Language
mailboxes	DTO_reference_mailbox[]		Mailboxes
tenant_users	DTO_reference_user[]		Tenant users
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
expired_trial	Boolean	ReadOnly	Expired trial
time_zone	String		Time zone
current_user_role	tenant_user_role (nullable)	ReadOnly	The current user's effective tenant role on this tenant. SUPER_ADMIN users are projected as OWNER.
is_active	Boolean	ReadOnly	Is active

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

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
role_enum_id	tenant_user_role (nullable)		Role enum id
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

GET Organizations / Get by id

GET Organizations / List product categories