Retry provisioning an alias
/api/v1/email-accounts/{account}/aliases/{alias}/retry-provisioningThis endpoint takes no request body.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
accountrequired | path | string | The account identifier. |
aliasrequired | path | string | The alias identifier. |
Request
/api/v1/email-accounts/{account}/aliases/{alias}/retry-provisioningcurl -X POST 'https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/aliases/01JBT8XQ2M9WYC3K4F6R7S8T9V/retry-provisioning' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY'const response = await fetch('https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/aliases/01JBT8XQ2M9WYC3K4F6R7S8T9V/retry-provisioning', {
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/01JBT8XQ2M9WYC3K4F6R7S8T9V/retry-provisioning",
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/01JBT8XQ2M9WYC3K4F6R7S8T9V/retry-provisioning');
$data = $response->json('data');require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/aliases/01JBT8XQ2M9WYC3K4F6R7S8T9V/retry-provisioning")
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.
dataobjectobjectstringmailbox_aliasidstringUnique identifier for the alias.
mailbox_idstringThe mailbox this alias delivers into. Retrieve it with
GET /api/v1/email-accounts/{email_account}.addressstringThe 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 | deletingThe same closed set, and the same ordering, as a mailbox
state, so one branch in your code handles both. Only anactivealias routes mail.provisioningobjectWhat 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 | deletedThe alias's setup state on the mail server, with the same values as a mailbox's
provisioning.state.provisioning.errornames any failure.errorstringWhy provisioning failed. null unless
stateisfailed.retryablebooleanTrue only while
stateisfailed, which is the only statePOST /aliases/{alias}/retry-provisioningaccepts.
created_atstringupdated_atstring
Returned inside the standard envelope.
Errors
| Status | When |
|---|---|
401 | The API key is missing, unknown, revoked or expired. All four answer identically, on purpose: distinguishing them would confirm which keys exist. |
403 | The key is valid but may not do this: it lacks the required scope, its IP allowlist does not include you, or this endpoint does not accept API keys. |
404 | No such resource in this organization. |
422 | The request was understood but the values were not acceptable. |
429 | Too many requests, or the organization has spent its sending allowance. `Retry-After` says how long to wait. |
Every status, with what causes it and what to do, is on the error reference.