Apply the reviewed retention policy to exactly one preview page.

POST

/api/admin/account-lifecycle/guest-retention/apply

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/account-lifecycle/guest-retention/apply \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "preview_token": "example" }'

Requires tenant-scoped account-lifecycle settings edit permission. Only accounts captured by the preview are considered. Changed, registered or deleting accounts are skipped. Deadlines are calculated from account creation, including already elapsed deadlines. Deletion itself runs in scheduled maintenance. Retrying the same preview is idempotent, including after a partial failure. A policy change requires a new preview. Subsequent pages require their own explicit apply request.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

preview_token

required

string

Example ^generated

{
  "preview_token": "example"
}

Responses

200

Result counts for the reviewed page, including writes completed by an earlier retry of this same page.

Media type application/json

object

applied

required

integer

unchanged

required

integer

skipped

required

integer

total

required

integer

<= 1000

Example ^generated

{
  "applied": 1,
  "unchanged": 1,
  "skipped": 1,
  "total": 1
}

400

A valid preview token is required.

401

Administrator authentication is required.

403

Tenant access or settings edit permission is denied.

409

The preview is expired

503

A transient failure interrupted application. Retry the same preview before it expires.