API v1Stable major · additive within v1

Claim an alias

Contract-first REST for builders and agents. Same control plane as Fat Heron products — documented here for the developer surface.

Create a mailbox alias on a domain already available to the account.

Required scopes: aliases:write · Base https://api.fatheron.dev

Steps

  1. 1. Optional availability check

    GET /v1/aliases/check?local_part=hello&domain=example.com
    X-API-Key: fh_live_…
  2. 2. Claim alias

    POST /v1/aliases
    X-API-Key: fh_live_…
    Content-Type: application/json
    
    {
      "local_part": "hello",
      "domain_name": "example.com",
      "forwards_to": "[email protected]"
    }

    201 response. status may be pending_destination until forward is verified.

Failure remediation

All agent recipes

Claim an alias · Fat Heron Developers