Domains and DNS

See a domain's inbox-link default

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

Who can use this: Site adminsAs Markdown

The setting covers accounts whose login address is at this domain. enabled is the default each of them follows until it makes its own choice. mode is where the link goes, for all of them: header (a List-Unsubscribe header), body (a line at the end of the message) or both.

Parameters

Name	Where	What it is
domain required	path	The domain name.e.g. example.com

Good to know

A domain that has never been set answers enabled false and mode header, with no updated_at.

curl -s 'https://api.mailmasker.org/api/v1/block-link/domains/example.com' \
  -H "Authorization: Bearer $TOKEN"

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

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

homelab-cli admin block-link domain show example.com

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"
}