Your AWS SES. Your dedicated Mailat. See how it works
Documentation

Update Settings

Request, response and authentication details for your Mailat instance.

← All API operations
PUT/api/v1/settings

UpdateSettings 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
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

bodyobjectrequired
Fields · service.UpdateSettingsRequest
autoAdvanceall of · nullable
Variant 1boolean
autoOrganizeDmarcReportsall of · nullable

Optional. Omit to preserve the current setting; false opts out for future arrivals without moving existing mail.

Variant 1boolean
blacklistAlertsall of · nullable
Variant 1boolean
bounceRateWarningsall of · nullable
Variant 1boolean
browserNotificationsall of · nullable
Variant 1boolean
campaignReportsall of · nullable
Variant 1boolean
conversationViewall of · nullable
Variant 1boolean
densityall of · nullable
Variant 1string
displayNameall of · nullable
Variant 1string
inboxLayoutall of · nullable
Variant 1string
newEmailNotificationsall of · nullable
Variant 1boolean
quotaWarningsall of · nullable
Variant 1boolean
showSnippetsall of · nullable
Variant 1boolean
themeall of · nullable
Variant 1string
weeklyDigestall of · nullable
Variant 1boolean

Responses

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

responseobject
Fields
codeintegerrequired
dataall of · nullable
Variant 1object
Fields · service.UserSettings
autoAdvanceboolean
autoOrganizeDmarcReportsboolean

Automatically file qualifying authenticated aggregate reports for this user. Does not configure DNS or receiving.

Default: true

blacklistAlertsboolean
bounceRateWarningsboolean
browserNotificationsboolean
campaignReportsboolean
conversationViewboolean
createdAtstring (date-time)
densitystring
displayNamestring
idinteger (int64)
inboxLayoutstring
newEmailNotificationsboolean
quotaWarningsboolean
showSnippetsboolean
themestring
twoFactorEnabledboolean
twoFactorMethodall of · nullable
Variant 1string
updatedAtstring (date-time)
userIdinteger (int64)
weeklyDigestboolean
messagestringrequired
400 · Invalid input

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
401 · Missing, expired or revoked authentication

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
403 · Insufficient permission

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
404 · Resource not found

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
409 · Conflict or changed idempotency payload

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
410 · Recovery cursor expired; resynchronize

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
429 · Rate limit exceeded; respect Retry-After
Header: Retry-Afterinteger

Seconds until the next fixed-minute request window.

minimum: 1

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
500 · Internal failure; retain the idempotency key

application/json

responseobject
Fields
codeintegerrequired
messagestringrequired
Download the full OpenAPI contract