Content

Mailboxes / List

Returns all email mailboxes.

Route: /api/{tenant:minlength(2)}/v{version:apiVersion}/mailboxes

Method: GET

Authorisation: Minimum role: USER

Name	Type	Source

Request body example

No input arguments

Response status: 200 (OK)

Response type: DTO_mailbox[]

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

Response body example

Name	Type	ReadOnly	Description
oauth2	DTO_external_auth_oauth2		Oauth2
group	DTO_reference		Group
setup	DTO_mailbox_setup	ReadOnly	Setup
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
id	Int32		Id
email_address	String		Email address
type	ENUM mailbox_type		Type
status	ENUM mailbox_status	ReadOnly	Status
import_as_knowledge	Boolean	ReadOnly	Import as knowledge
import_tickets	Boolean	ReadOnly	Import tickets
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated

Name	Type	ReadOnly	Description
identifier	String		Identifier
authorized_account	String	ReadOnly	Authorized account

Name	Type	ReadOnly	Description
id	Int32		The id of the reference
label	Object	ReadOnly	Name/Label from referenced object.

Name	Type	ReadOnly	Description
import_in_progress	Boolean	ReadOnly	Import in progress
dns_setups	DTO_dns_setup[]	ReadOnly	Dns setups
forward_to	String	ReadOnly	Forward to

Name	Type	Description
type	ENUM dns_record_type	Type
status	ENUM dns_setup_status	Status
host_value	String	Host value
data	String	Data

Name	Type	ReadOnly	Description
profile_pic	String	ReadOnly	Profile pic
email	String	ReadOnly	Email
id	Int32		Id
label	Object	ReadOnly	Label

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	PENDING	Waiting client to setup DNS records (or verification of it)
2	INSTALLING	Client DNS record setup completed, and verification done
3	COMPLETED	Install completed

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

PUT Mailboxes / Update

GET Mailboxes / List domains