Skip to main content
POST
Preview sponsorship archive or restoration

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

action
enum<string>
required
Available options:
archive,
restore
Example:

"archive"

donor_entity_ids
required
program_id

Current program selection or all programs.

Example:

42

query
string

Current worksheet search for all selection.

Example:

"Jane"

savedFilterId
integer
Example:

42

filterGroups
object[]

Current worksheet filter groups passed to filtered all selection.

fields
string[]

Current worksheet selected fields; also triggers filtered sponsorship resolution.

filter

True for true, integer1 or case-insensitive1/true/on/yes; otherwise false.

Example:

true

status
enum<string>
Available options:
current,
due
Example:

"current"

Response

Operation result.

action
enum<string>
Available options:
archive,
restore
Example:

"archive"

count
integer
Required range: x >= 0
Example:

1

sponsorships
object[]
resolved_donor_entity_ids
integer[]
preview_token
string

Opaque encrypted review token for the subsequent matching lifecycle action.

Example:

"EXAMPLE_ENCRYPTED_PREVIEW_TOKEN"

preview_expires_at
string<date-time>
Example:

"2026-10-20T12:10:00Z"