Skip to main content
POST
Sweep expired letters

Authorizations

Authorization
string
header
required

Operator-only shared secret (AROPAY_MAIL_SWEEP_SECRET, at least 32 characters) presented as Authorization: Bearer <secret> by the scheduler that runs POST /transfer/letter/sweep. Not a user credential: API keys and sessions are never accepted there.

Response

Sweep summary.

ok
any
required
data
object
required

Outcome of one POST /transfer/letter/sweep run.