Generate Password a email account

Parameters

Request

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

const response = await fetch('https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/generate-password', {
  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/generate-password",
    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/generate-password');

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

require "net/http"
require "json"
uri = URI("https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/generate-password")
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_password
  • mailbox_idstring

    The mailbox whose password changed. Retrieve it with `GET /api/v1/email-accounts/{email_account}`.

  • passwordstring

    **Returned exactly once, in this response, and never retrievable again.** Store it before you discard the response: we keep it encrypted and no endpoint can read it back, so a lost value can only be replaced by setting another password. Populated by `POST /generate-password`, which generated it. **null from `POST /reset-password`** — there you supplied the password and already hold it; null there means "not ours to return", not "unknown".

  • changed_atstring

    When the password moved — in practice the instant of this request, because both endpoints stamp it as they write and then hand back what they just wrote. **Never null in this response**, and not nullable. The column behind it IS nullable and a mailbox whose password has never been changed holds null there, but the only way to receive this object is to change one, so that null cannot reach you here. The only place the published contract reports this, and only to the caller that just moved it — the mailbox object carries no credential timestamps, so there is no endpoint that will tell you when some other mailbox's password last changed.

Returned inside the standard envelope.

Errors

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