Skip to main content
POST
Create email domain

Authorizations

Authorization
string
header
required

Use your account ID as the username and your personal access token (PAT) as the password, or pass a Base64-encoded value directly in the Authorization header. For more information, see the personal access tokens guide.

Body

application/json
name
string
required

Email domain name.

If only fragment is provided, the name.helpdesk.com domain will be created. If full domain is provided, ownership verification will be performed during this API call. The system will look for CNAME record with hostname of hd-<licenseID>.yourdomain.com pointing to helpdesk.com. The request will fail if no such record is found.

Response

200 - application/json

Successful response.

ID
string<uuid>

Unique object identifier.

licenseID
integer

Unique account identifier.

createdAt
string<date-time>

The time of creation.

createdBy
string<uuid>

The creator identifier.

createdByType
enum<string>

The creator type.

Available options:
agent,
client,
system
updatedAt
string<date-time>

The time of last modification.

updatedBy
string<uuid>

The modification author identifier.

name
string

Email domain name.

If only fragment is provided, the name.helpdesk.com domain will be created. If full domain is provided, ownership verification will be performed during this API call. The system will look for CNAME record with hostname of hd-<licenseID>.yourdomain.com pointing to helpdesk.com. The request will fail if no such record is found.

status
enum<string>

Domain status

Available options:
new,
pendingConfiguration,
pendingVerification,
active,
pendingDeletion,
setupFailed
dns
object

DNS records that have to be set in domain DNS.

flags
object