Domains and DNS

Set a domain's inbox-link default

PUT/api/v1/block-link/domains/:domain

Who can use this: Site adminsAs Markdown

Accounts whose login address is at this domain follow enabled unless they have made their own choice; mode applies to all of them.

Parameters

Name	Where	What it is
domain required	path	The domain name.e.g. example.com
enabled required	body	true to add the link by default, false for none.e.g. true
mode required	body	Where the link goes, `header`, `body` or `both`.e.g. both

curl -s -X PUT 'https://api.mailmasker.org/api/v1/block-link/domains/example.com' \
  -H "Authorization: Bearer $TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{"enabled":true,"mode":"both"}'

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

my $ua  = Mojo::UserAgent->new;
my $res = $ua->put('https://api.mailmasker.org/api/v1/block-link/domains/example.com',
    { Authorization => "Bearer $ENV{TOKEN}" },
    json => { enabled => \1, mode => 'both' })->result;
die $res->code, ' ', ($res->json('/error') // $res->message), "\n" unless $res->is_success;
print $res->body, "\n";

homelab-cli admin block-link domain set example.com --enabled --mode both

Response 200 OK

{
  "domain_name": "example.com",
  "enabled": 1,
  "mode": "both",
  "updated_by_email": "you@example.com",
  "updated_at": "2026-11-03 21:42:10.123456-06"
}