logo
ForwardingRequest alias creation confirmation email

Request alias creation confirmation email

Use address plus to, or name plus to with optional domain.

curl -X GET "https://mail.haltman.io/api/forward/subscribe?to=user@example.com&address=123 Main St&name=John Doe&domain=example_string" \
  -H "Content-Type: application/json"
{
  "ok": true,
  "action": "subscribe",
  "alias_candidate": "example_string",
  "to": "user@example.com",
  "confirmation": {
    "sent": true,
    "ttl_minutes": 42
  }
}
GET
/api/forward/subscribe
GET
query
tostring
Required

Destination email address.

Format: email
query
addressstring

Full alias address. Cannot be combined with name or domain.

query
namestring

Alias local-part used when address is omitted.

query
domainstring

Alias domain. Defaults to DEFAULT_ALIAS_DOMAIN when omitted.

Request Preview
Response

Response will appear here after sending the request

Query Parameters

tostring
Required

Destination email address.

addressstring

Full alias address. Cannot be combined with name or domain.

namestring

Alias local-part used when address is omitted.

domainstring

Alias domain. Defaults to DEFAULT_ALIAS_DOMAIN when omitted.

Responses

okboolean
Required
actionstring
Required
Allowed values:subscribe
alias_candidatestring
Required
tostring
Required
confirmationobject
Required