logo
HandleRequest handle claim confirmation email

Request handle claim confirmation email

Initiates a handle claim. A confirmation email is sent to the destination address. The handle is only created after the token from the email is confirmed. Handles are permanent — once claimed, the name can never be reused, even after unsubscribe.

curl -X GET "https://mail.haltman.io/api/handle/subscribe?handle=example_string&to=user@example.com" \
  -H "Content-Type: application/json"
{
  "ok": true,
  "action": "handle_subscribe",
  "handle": "example_string",
  "to": "user@example.com",
  "confirmation": {
    "sent": true,
    "ttl_minutes": 42,
    "reason": "example_string"
  }
}
GET
/api/handle/subscribe
GET
query
handlestring
Required

The local-part to claim. Must be a valid RFC 5322 dot-atom local-part.

Max length: 64 • Pattern: ^[a-z0-9!#$%&'*+/=?^_`{|}~-]+(?:\.[a-z0-9!#$%&'*+/=?^_`{|}~-]+)*$
query
tostring
Required

Destination email address where all handle mail will be forwarded.

Format: email
Request Preview
Response

Response will appear here after sending the request

Query Parameters

handlestring
Required

The local-part to claim. Must be a valid RFC 5322 dot-atom local-part.

tostring
Required

Destination email address where all handle mail will be forwarded.

Responses

okboolean
Required
actionstring
Required
Allowed values:handle_subscribe
handlestring
Required
tostring
Required
confirmationobject
Required