Add an alias

Parameters

Request

curl -X POST 'https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/aliases' \
  -H 'Authorization: Bearer mk_live_YOUR_API_KEY'

const response = await fetch('https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/aliases', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer mk_live_YOUR_API_KEY',
  },
});
const { data } = await response.json();

import requests
response = requests.post(
    "https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/aliases",
    headers={"Authorization": "Bearer mk_live_YOUR_API_KEY"},
)
data = response.json()["data"]

<?php

$response = Http::withToken('mk_live_YOUR_API_KEY')
    ->post('https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/aliases');

$data = $response->json('data');

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/aliases")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer mk_live_YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

Response

Success.

• dataobject
  • objectstringmailbox_alias
  • idstring

    Unique identifier for the alias.

  • mailbox_idstring

    The mailbox this alias delivers into. Retrieve it with `GET /api/v1/email-accounts/{email_account}`.

  • addressstring

    The additional address. An alias **receives only** — it cannot be used as an SMTP login, and mail sent through it still leaves as the mailbox.

  • statestringactive | provisioning | failed | suspended | deleting

    The same closed set, and the same ordering, as a mailbox `state`, so one branch in your code handles both. Only an `active` alias routes mail.

  • provisioningobject

    What the mail server has done with this alias. Creation is asynchronous, so an alias exists here before it routes anything there.

    • statestringpending | provisioning | active | failed | suspended | deleting | deleted

      What the mail server has recorded for this alias, as stored. **Never null**, and not nullable: `email_aliases.provisioning_state` is NOT NULL and defaults to `pending`, and an alias is created with `pending` written explicitly. It comes from our database rather than a live call, so an unreachable mail server leaves this STALE rather than unknown — `provisioning.error` is where a failure gets named, and that one is null when there is genuinely no error. Same set and same meanings as a mailbox's `provisioning.state`.

    • errorstring

      Why provisioning failed. null unless `state` is `failed`.

    • retryableboolean

      True only while `state` is `failed`, which is the only state `POST /aliases/{alias}/retry-provisioning` accepts.

  • created_atstring
  • updated_atstring

Returned inside the standard envelope.

Errors

Every status, with what causes it and what to do, is on the error reference.