HostingImports
Create import
POST
/api/importsCreates a CSV import for domains, domain aliases, email accounts, or email aliases.
Authorization
api_key X-Api-Token<token>
API token used to authenticate requests.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
csv_file_name*string
Original import CSV file name.
csv_file_content*string
Import CSV file content, optionally as a data URL with base64 payload.
csv_file_size?integer
Import CSV file size in bytes.
Format
int32customer_code?string
Customer code that owns the import. Admin only.
type*string
Resource type contained in the CSV import.
alias_domains= domain aliases.domains= domains.alias_email_accounts= email aliases.email_accounts= mailboxes.
Values
alias_domains | domains | alias_email_accounts | email_accountsexpert_mode?boolean
Enable expert import mode where allowed.
skip_invalid_resources?boolean
Skip invalid resources during import validation. Admin only.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/imports" \ -H "X-Api-Token: YOUR_API_TOKEN" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d '{ "csv_file_name": "string", "csv_file_content": "string", "type": "alias_domains" }'{
"message": "string",
"resource_code": "string"
}{
"message": "Unauthorized",
"errors": []
}{
"message": "Forbidden",
"errors": []
}{
"message": "Not found",
"errors": []
}{
"message": "Validation failed",
"errors": [
{
"field": "name",
"description": "is not valid"
}
]
}