Aliases

Create an alias

Creates a forwarding alias that delivers to one or more destination addresses. The domain must be DNS-verified — mail cannot route to an alias on an unverified domain, so creation is rejected with a 403. Requires scope aliases:write.

post/aliases

Request

  • Base URL: https://faivelo.com/api/v1
  • URL: https://faivelo.com/api/v1/aliases
  • Auth: HTTP bearer

Request body

domainstring required
localPartstring

The part before the @. 1–64 chars, alphanumeric plus ._%+-. Required unless catchAll is true.

catchAllboolean

Create the domain catch-all (*@domain): forwards mail sent to any address that has no mailbox or alias of its own. One per domain.

destinationsstring[] required

One or more email addresses to forward to (max 20)

Example request

{
  "domain": "yourdomain.com",
  "localPart": "info",
  "destinations": [
    "jane@yourdomain.com"
  ]
}

Response

Alias created

successboolean

Example response

{
  "success": true,
  "data": {
    "address": "info@yourdomain.com",
    "localPart": "info",
    "destinations": [
      "jane@yourdomain.com",
      "bob@yourdomain.com"
    ],
    "active": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.