Imports

Create

Creates an email import that pulls the messages of one mailbox folder into the chosen group as historical tickets. Exactly one of email.imap and email.oauth2 must be supplied, the credentials are tested against the server during the call, the folder must exist and hold at least one message, the same mailbox and folder cannot be imported twice, and the plan's limit on imported messages is enforced. The response returns before anything is imported: retrieval and the AI evaluation that decides which messages become knowledge run in a background job started here.

POST /api/{tenant:minlength(2)}/v{version:apiVersion}/imports

Authorisation: Minimum role: ADMIN

Request arguments

Name	Type	Source
input	DTO_import	Body

Request body example

Response

Status: 200 (OK)
Type: DTO_import

Wrapper: DTO_response_wrap

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

Response body example

DTO_import

Name	Type	ReadOnly	Description
created_by	DTO_reference_user	ReadOnly	Created by
last_updated_by	DTO_reference_user	ReadOnly	Last updated by
group	DTO_reference		Group
email	DTO_import_email		Email
data_dump	DTO_import_data_dump		Data dump
id	Int32	ReadOnly	Leave empty on input
friendly_name	String		Friendly name
created	DateTime	ReadOnly	Created
last_updated	DateTime	ReadOnly	Last updated
type	ENUM import_type		Type

DTO_reference_user

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

DTO_reference

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

DTO_import_email

Name	Type	ReadOnly	Description
imap	DTO_external_auth_imap		Imap
oauth2	DTO_external_auth_oauth2		Oauth2
mailbox	String		Leave empty for current user
mailbox_folder_name	String		Mailbox folder name
total_message_count	Int32	ReadOnly	Total message count
retrieved_count	Int32	ReadOnly	Retrieved count
status	ENUM import_email_status	ReadOnly	Status

DTO_external_auth_imap

Name	Type	Description
hostname	String	Hostname
port	Int32	Port
username	String	Username
password	String	Password

DTO_external_auth_oauth2

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

DTO_import_data_dump

Name	Type	ReadOnly	Description
total_count	Int32		Total count
provider	ENUM import_data_dump_provider		Provider

ENUM import_email_status

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	IN_PROGRESS	In progress
2	DONE	Done
3	ERROR	Error

ENUM import_data_dump_provider

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	GROOVEHQ	GrooveHQ
2	EXCEL_QA	Excel Q&A
3	EXCEL_QUESTIONNAIRE	Excel Questionnaire
4	SUPPORT_BOX_EML	SupportBox EML

ENUM import_type

Value	Name	Description
0	UNKNOWN	UNKNOWN
1	EMAIL	Email
2	DATA_DUMP	Data dump

Generated Aug 4, 2026 18:37