logo
Alias APICreate an alias for the API key owner

Create an alias for the API key owner

Accepts JSON body or query string. When both are present, the body takes precedence.

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"
}'
{
  "ok": true,
  "created": true,
  "address": "123 Main St",
  "goto": "example_string"
}
POST
/api/alias/create
POST
API Key (header: X-API-Key)
X-API-Keystring
Required

64-character lowercase hexadecimal API key.

64-character lowercase hexadecimal API key.
Content-Typestring
Required

The media type of the request body

Options: application/json
Request Preview
Response

Response will appear here after sending the request

Authentication

header
X-API-Keystring
Required

API Key for authentication. 64-character lowercase hexadecimal API key.

Query Parameters

Responses

okboolean
Required
createdboolean
Required
addressstring
Required
gotostring
Required