Generate Password a email account
/api/v1/email-accounts/{account}/generate-passwordParameters
| Name | In | Type | Description |
|---|---|---|---|
accountrequired | path | string | The account identifier. |
Request body
lengthintegerHow many characters the generated password has.
include_symbolsbooleanWhether the generated password may contain symbols.
must_change_passwordbooleanMake the person choose their own password at their next sign-in to webmail or the app.
send_tostringOptional. An address to email the new password to. Not the mailbox itself: its owner cannot sign in to read it.
Request
/api/v1/email-accounts/{account}/generate-passwordcurl -X POST 'https://app.mailyte.com/api/v1/email-accounts/01JBT8XQ2M9WYC3K4F6R7S8T9V/generate-password' \
-H 'Authorization: Bearer mk_live_YOUR_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"length": 16,
"include_symbols": true
}'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',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"length": 16,
"include_symbols": true
}),
});
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"},
json={
"length": 16,
"include_symbols": true
},
)
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', [
'length' => 16,
'include_symbols' => true,
]);
$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"
request["Content-Type"] = "application/json"
request.body = {
"length": 16,
"include_symbols": true
}.to_json
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }Response
Success.
dataobjectobjectstringmailbox_passwordmailbox_idstringThe mailbox whose password changed. Retrieve it with
GET /api/v1/email-accounts/{email_account}.passwordstringThe new password, from
POST /generate-password. **It is shown only once, here**: save it now, because it can never be read again. Null fromPOST /reset-password, where you chose the password yourself.changed_atstringWhen the password was changed, which is the time of this request.
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.