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"
import requests
import json
url = "https://mail.haltman.io/api/forward/subscribe?to=user@example.com&address=123 Main St&name=John Doe&domain=example_string"
headers = {
"Content-Type": "application/json"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://mail.haltman.io/api/forward/subscribe?to=user@example.com&address=123 Main St&name=John Doe&domain=example_string", {
method: "GET",
headers: {
"Content-Type": "application/json"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://mail.haltman.io/api/forward/subscribe?to=user@example.com&address=123 Main St&name=John Doe&domain=example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://mail.haltman.io/api/forward/subscribe?to=user@example.com&address=123 Main St&name=John Doe&domain=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
response = http.request(request)
puts response.body
{
"ok": true,
"action": "subscribe",
"alias_candidate": "example_string",
"to": "user@example.com",
"confirmation": {
"sent": true,
"ttl_minutes": 42
}
}
{
"error": "example_string",
"field": "example_string",
"reason": "example_string",
"hint": "example_string",
"constraints": {}
}
{
"error": "example_string"
}
{
"error": "example_string",
"ban": {},
"type": "example_string",
"value": "example_string"
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"details": "Resource already exists"
}
{
"error": "example_string",
"where": "example_string",
"reason": "example_string"
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
GET
/api/forward/subscribe
GET
query
tostring
RequiredDestination 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
RequiredDestination 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
Requiredactionstring
RequiredAllowed values:
subscribealias_candidatestring
Requiredtostring
Requiredconfirmationobject
RequiredWas this page helpful?
Last updated 2 days ago
Built with Documentation.AI