Aliases

Create new domain alias

Create a new alias for a specific domain. Note: this endpoint does not accept password or new_password fields. To set or change alias credentials, use the "POST /v1/domains/:domain_id/aliases/:alias_id/generate-password" endpoint.

post/v1/domains/{domain_id}/aliases

Request

  • Base URL: https://api.forwardemail.net
  • URL: https://api.forwardemail.net/v1/domains/{domain_id}/aliases
  • Auth: HTTP basic

Request body

namestring

Alias name (if not provided or if blank, then a random alias is generated)

descriptionstring

Alias description

has_recipient_verificationboolean

Require recipients to click verification link (defaults to domain setting)

is_enabledboolean

Whether to enable or disable this alias

error_code_if_disabled250 | 421 | 550

Error code if alias is disabled. Defaults to 250

has_imapboolean

Enable or disable IMAP storage for this alias

has_pgpboolean

Enable or disable OpenPGP encryption for this alias

public_keystring

OpenPGP public key in ASCII Armor format

has_smimeboolean

Enable or disable S/MIME encryption for this alias

smime_certificatestring

S/MIME X.509 certificate in PEM format

has_wkd_disabledboolean

Whether WKD (Web Key Directory) public key lookup is disabled for this alias

max_quotastring

Storage max quota (e.g. '1 GB')

vacation_responder_is_enabledboolean

Enable or disable vacation responder

vacation_responder_start_datestring

Start date (e.g. 'YYYY-MM-DD') for vacation responder

vacation_responder_end_datestring

End date (e.g. 'YYYY-MM-DD') for vacation responder

vacation_responder_subjectstring

Plaintext subject for vacation responder

vacation_responder_messagestring

Plaintext message for vacation responder

retentioninteger

Retention period in days (0-365) for Trash and Junk mailbox cleanup. Set to 0 to use automatic storage-based scaling.

smtp_limitinteger

Per-alias daily SMTP outbound message limit. Set to 0 to use the domain-level limit.

Response

Domain alias created successfully

namestring required
labelsstring[] required
is_enabledboolean required
has_recipient_verificationboolean required
verified_recipientsstring[] required
pending_recipientsstring[] required
recipientsstring[] required
idstring required
object'alias' required
created_atstring date-time required
updated_atstring date-time required
storage_locationstring required
has_imapboolean required
retentioninteger required

Retention period in days (0-365) for Trash and Junk mailbox cleanup. 0 means automatic storage-based scaling.

smtp_limitinteger

Per-alias daily SMTP outbound message limit. Set to 0 to use the domain-level limit.

is_smtp_suspendedboolean

Whether this alias is currently suspended from outbound SMTP access.

smtp_suspended_sent_atstring date-time nullable

The date and time when the alias was suspended from outbound SMTP.

Example response

{
  "user": {
    "email": "test@test.com",
    "display_name": "test@test.com",
    "id": "5efabd39xxxxxxx4512890b8"
  },
  "domain": {
    "name": "mailsire.com",
    "id": "5e3c0550xxxxxxx09b7ba023"
  },
  "name": "abc123",
  "labels": [],
  "is_enabled": true,
  "has_recipient_verification": false,
  "verified_recipients": [],
  "pending_recipients": [],
  "recipients": [
    "abc@test1.com"
  ],
  "id": "62fa3dcxxxxxxx79dda83ff2",
  "object": "alias",
  "created_at": "2022-08-15T12:36:26.593Z",
  "updated_at": "2022-08-15T12:36:26.593Z",
  "storage_location": "storage_loc",
  "has_imap": false,
  "retention": 0
}

Changes

No recorded changes to this operation across all 1 revision of this API.