Update Settings
Request, response and authentication details for your Mailat instance.
/api/v1/settingsUpdateSettings updates the current user's settings PUT /api/v1/settings Human session required; scoped API keys cannot access account settings. autoOrganizeDmarcReports defaults to true, including users without a settings row. Omit the update field to preserve it; false opts out of sorting future arrivals. The preference does not move existing messages, remove the folder or change DNS/receiving setup.
Authentication & compatibility
This operation requires an active human session. API keys cannot call it. Additional role or MFA checks may apply.
Mailat application, account or shared resource API. Individual operations can require configured external services; this label is not a runtime-readiness guarantee.
Contract 2026-10-04. Your running instance's /api/v1/openapi.json is authoritative for its deployed release.
Request
Set MAILAT_BASE_URL to your instance origin (without /api/v1) and MAILAT_TOKEN to an appropriate credential. Replace path placeholders and example data before running. These examples do not execute in this page.
curl --request PUT "$MAILAT_BASE_URL/api/v1/settings" \
--header "Authorization: Bearer $MAILAT_TOKEN" \
--header 'Content-Type: application/json' \
--data '{
"autoOrganizeDmarcReports": false
}'Request body (required)
application/json
bodyobjectrequiredFields · service.UpdateSettingsRequest
autoAdvanceall of · nullableVariant 1booleanautoOrganizeDmarcReportsall of · nullableOptional. Omit to preserve the current setting; false opts out for future arrivals without moving existing mail.
Variant 1booleanblacklistAlertsall of · nullableVariant 1booleanbounceRateWarningsall of · nullableVariant 1booleanbrowserNotificationsall of · nullableVariant 1booleancampaignReportsall of · nullableVariant 1booleanconversationViewall of · nullableVariant 1booleandensityall of · nullableVariant 1stringdisplayNameall of · nullableVariant 1stringinboxLayoutall of · nullableVariant 1stringnewEmailNotificationsall of · nullableVariant 1booleanquotaWarningsall of · nullableVariant 1booleanshowSnippetsall of · nullableVariant 1booleanthemeall of · nullableVariant 1stringweeklyDigestall of · nullableVariant 1booleanResponses
HTTP statuses and body shapes below come from the pinned contract. Not every shared error applies to every request. Retain the original idempotency key when retrying a send.
200 · Success
application/json
responseobjectFields
codeintegerrequireddataall of · nullableVariant 1objectFields · service.UserSettings
autoAdvancebooleanautoOrganizeDmarcReportsbooleanAutomatically file qualifying authenticated aggregate reports for this user. Does not configure DNS or receiving.
Default: true
blacklistAlertsbooleanbounceRateWarningsbooleanbrowserNotificationsbooleancampaignReportsbooleanconversationViewbooleancreatedAtstring (date-time)densitystringdisplayNamestringidinteger (int64)inboxLayoutstringnewEmailNotificationsbooleanquotaWarningsbooleanshowSnippetsbooleanthemestringtwoFactorEnabledbooleantwoFactorMethodall of · nullableVariant 1stringupdatedAtstring (date-time)userIdinteger (int64)weeklyDigestbooleanmessagestringrequired400 · Invalid input
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired401 · Missing, expired or revoked authentication
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired403 · Insufficient permission
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired404 · Resource not found
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired409 · Conflict or changed idempotency payload
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired410 · Recovery cursor expired; resynchronize
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired429 · Rate limit exceeded; respect Retry-After
Header: Retry-AfterintegerSeconds until the next fixed-minute request window.
minimum: 1
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired500 · Internal failure; retain the idempotency key
application/json
responseobjectFields
codeintegerrequiredmessagestringrequired