Admin User Mutations

Generated admin user mutations operations.

POST/v1/admin/user-mutations/retireRetire an account's old receipt history without changing user dataadmin

Audience: Clients · Native API
Authorization: API key or personal access token with the admin scope, or a signed-in session
OpenAPI operation ID: retire_user_mutations
Max body: 1 KiB

Request body application/json · required

Example

{
  "accountId": "id_8h2k4q",
  "authority": "string",
  "confirmReceiptHistoryLoss": true
}

Schema

accountIdstringrequired
authoritystringrequired
confirmReceiptHistoryLossbooleanrequired

Responses

200Successapplication/json

Example

{
  "retentionDays": 0,
  "retiredBeforeMs": 1800000,
  "serverTimeMs": 1800000
}

Schema

retentionDaysintegerrequired
retiredBeforeMsintegerrequired
serverTimeMsintegerrequired

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busywriter_capacity

Example request

curl -X POST "http://127.0.0.1:32500/v1/admin/user-mutations/retire" \
  -H "Authorization: Bearer $PORTICO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"accountId":"id_8h2k4q","authority":"string","confirmReceiptHistoryLoss":true}'