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

Update identities

Request, response and authentication details for your Mailat instance.

← All API operations
POST/api/v1/identities/{uuid}/catch-all

Update

Authentication & compatibility

Use a scoped bearer API key with identities:manage. The key is bound to its user and organization.

Owned sender identities support SES. Legacy identities with a Stalwart account can also synchronize password/deletion changes to Stalwart; SES identities do not require a separate mailbox server.

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 POST "$MAILAT_BASE_URL/api/v1/identities/{uuid}/catch-all" \
  --header "Authorization: Bearer $MAILAT_TOKEN" \
  --header 'Content-Type: application/json' \
  --data @request.json

Build the request from the schema below; request.json and upload paths are local placeholders.

Parameters

path
uuidstringrequired

Request body (required)

application/json

bodyobjectrequired
Fields · model.UpdateIdentityRequest
colorall of · nullable
Variant 1string
displayNameall of · nullable
Variant 1string
isCatchAllall of · nullable
Variant 1boolean
isDefaultall 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
Header: X-RateLimit-Remaininginteger

Remaining requests in this API key's current minute window (present for API-key authentication).

minimum: 0

application/json

responseobject
Fields
codeintegerrequired
dataall of · nullable
Variant 1object
Fields · model.Identity
canReceiveboolean
canSendboolean
colorstring

Hex color for UI display

createdAtstring (date-time)
displayNamestring
domainIdinteger (int64)
emailstring
idinteger (int64)
isCatchAllboolean
isDefaultboolean
quotaBytesinteger (int64)
stalwartAcctIdstring
statusstring
updatedAtstring (date-time)
usedBytesinteger (int64)
userIdinteger (int64)
uuidstring
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