Endpoints
Create alias for authenticated owner
Accepts alias_handle and alias_domain in JSON body or query.
curl -X POST "https://mail.haltman.io/api/alias/create?alias_handle=example_string&alias_domain=example_string" \
-H "Content-Type: application/json" \
-H "X-API-Key: YOUR_API_KEY" \
-d '{
"alias_handle": "example_string",
"alias_domain": "example_string"
}'
import requests
import json
url = "https://mail.haltman.io/api/alias/create?alias_handle=example_string&alias_domain=example_string"
headers = {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY"
}
data = {
"alias_handle": "example_string",
"alias_domain": "example_string"
}
response = requests.post(url, headers=headers, json=data)
print(response.json())
const response = await fetch("https://mail.haltman.io/api/alias/create?alias_handle=example_string&alias_domain=example_string", {
method: "POST",
headers: {
"Content-Type": "application/json",
"X-API-Key": "YOUR_API_KEY"
},
body: JSON.stringify({
"alias_handle": "example_string",
"alias_domain": "example_string"
})
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
"bytes"
"encoding/json"
)
func main() {
data := []byte(`{
"alias_handle": "example_string",
"alias_domain": "example_string"
}`)
req, err := http.NewRequest("POST", "https://mail.haltman.io/api/alias/create?alias_handle=example_string&alias_domain=example_string", bytes.NewBuffer(data))
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-API-Key", "YOUR_API_KEY")
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/alias/create?alias_handle=example_string&alias_domain=example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['X-API-Key'] = 'YOUR_API_KEY'
request.body = '{
"alias_handle": "example_string",
"alias_domain": "example_string"
}'
response = http.request(request)
puts response.body
{
"ok": true,
"created": true,
"address": "123 Main St",
"goto": "example_string"
}
{
"error": "Bad Request",
"message": "The request contains invalid parameters or malformed data",
"code": 400,
"details": [
{
"field": "email",
"message": "Invalid email format"
}
]
}
{
"error": "Unauthorized",
"message": "Authentication required. Please provide a valid API token",
"code": 401
}
{
"error": "Conflict",
"message": "The request conflicts with the current state of the resource",
"code": 409,
"details": "Resource already exists"
}
{
"error": "Too Many Requests",
"message": "Rate limit exceeded. Please try again later",
"code": 429,
"retryAfter": 3600
}
{
"error": "Internal Server Error",
"message": "An unexpected error occurred on the server",
"code": 500,
"requestId": "req_1234567890"
}
POST
/api/alias/create
POST
Security Scheme
API Key (header: X-API-Key)
X-API-Keystring
RequiredAPI key (sent in header)
Content-Typestring
RequiredThe media type of the request body
Options: application/json
Request Preview
Response
Response will appear here after sending the request
Authentication
ApiKeyAuth
header
X-API-Keystring
RequiredAPI Key for authentication. Provide your API key in the header.
Query Parameters
Responses
okboolean
createdboolean
addressstring
gotostring
Was this page helpful?
Built with Documentation.AI
Last updated 1 week ago