Domains and DNS

Give an account an extra address

POST/api/v1/domains/mail-aliases

Who can use this: Site adminsAs Markdown

Mail to the address goes to the account, which may also send from it unless send_enabled is false. For a whole domain, that is every address there without a mailbox or entry of its own. Giving an address that is already routed moves it to the new account.

Parameters

Name	Where	What it is
source_pattern required	body	An exact address, or `@` and a domain for the whole domain.e.g. sales@example.com
destination required	body	The account it goes to. It isn't checked, so make sure it is a real one.e.g. you@example.com
send_enabled	body	Whether the account may send from it. true if left out.

Good to know

A domain that isn't listed yet is added, with a DNS zone but with mail off. The account can send from it, but mail sent to it arrives only once mail is turned on (Change a domain's settings).
If that DNS zone can't be created, the answer is 502 and nothing is added.

curl -s -X POST 'https://api.mailmasker.org/api/v1/domains/mail-aliases' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"source_pattern":"sales@example.com","destination":"you@example.com"}'

use Mojo::Base -strict;
use Mojo::UserAgent;

my $ua  = Mojo::UserAgent->new;
my $res = $ua->post('https://api.mailmasker.org/api/v1/domains/mail-aliases',
    { Authorization => "Bearer $ENV{TOKEN}" },
    json => { source_pattern => 'sales@example.com', destination => 'you@example.com' })->result;
die $res->code, ' ', ($res->json('/error') // $res->message), "\n" unless $res->is_success;
print $res->body, "\n";

homelab-cli dns mail-aliases add sales@example.com you@example.com

Response 201 Created

{
  "id": 5,
  "source_pattern": "sales@example.com",
  "destination": "you@example.com",
  "active": 1,
  "send_enabled": 1,
  "created_by": "you@example.com",
  "created_at": "2026-11-03 21:42:10.123456-06",
  "updated_at": "2026-11-03 21:42:10.123456-06"
}