Preview sponsorship archive or restoration
Requires configured sponsorship lifecycle rollout (or the legacy lifecycle-controls flag) and access to every selected effective program. Resolves explicit ids or current filtered all selection; restore always selects archived relationships. At most250 relationship ids may be previewed. Returns one row per associated commitment, or a relationship-only row where none exists, so count is preview row count and can exceed relationship count. Produces a10-minute encrypted token bound to organization, actor, action, exact relationship ids and current relationship/commitment state. No archive, restore or charge is applied. Requires permission: one of manage_programs.
Authorizations
Passport bearer token authentication for legacy admin sessions.
Body
Validated request fields for this operation.
archive, restore "archive"
Current program selection or all programs.
42
Current worksheet search for all selection.
"Jane"
42
Current worksheet filter groups passed to filtered all selection.
Current worksheet selected fields; also triggers filtered sponsorship resolution.
True for true, integer1 or case-insensitive1/true/on/yes; otherwise false.
true
current, due "current"
Response
Operation result.
archive, restore "archive"
x >= 01
Opaque encrypted review token for the subsequent matching lifecycle action.
"EXAMPLE_ENCRYPTED_PREVIEW_TOKEN"
"2026-10-20T12:10:00Z"