Skip to main content
POST
Review bulk commitment changes

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json
values
object
required

At least one supported commitment field; preview projects financial fields without writing.

donor_entity_ids

Required unless retrying failed_operation. Positive relationship ID list, or exact all string for program/filter scope.

Selected sponsorship relationship ID.

Required range: x >= 1
selection_mode
enum<string> | null

Default selected_rows; all_total and failed_operation return grouped outcomes without per-row enumeration.

Available options:
selected_rows,
all_total,
failed_operation,
null
Example:

"selected_rows"

failed_operation_id
string<uuid> | null

Required for failed_operation; complete failed commitment scope from a previous tracked operation.

Example:

"d38103d8-1e8b-47ab-ae04-7e1f8a3bc727"

selected_count
integer | null

UI selection count, accepted as a hint.

Required range: x >= 1
Example:

2

program_id

Effective sponsorship program scope for all selection, or all programs.

Required range: x >= 1
Example:

"all"

pageIndex
integer | null

Worksheet compatibility input; full filtered selection is collected across pages.

Required range: x >= 1
Example:

1

pageSize
integer | null

Worksheet compatibility input; resolver collects pages of250.

Required range: x >= 1
Example:

25

sortOrder
string | null

Worksheet sorting direction.

Example:

"Example"

sortKey
string | null

Worksheet sorting key.

Example:

"Example"

query
string | null

Worksheet search query.

Example:

"Example"

filter
any

Archived selector as boolean/numeric/string; unavailable archived commitments fail completeness checks.

Example:

"false"

status
enum<string> | null

Supported worksheet status view.

Available options:
current,
due,
null
Example:

"current"

filterGroups
object[] | null
savedFilterId
any | null

Owned saved sponsorship worksheet definition to resolve.

Example:

42

fields

Worksheet-selected field keys or supported legacy encoded columns.

Worksheet field key.

column_order
string[] | null

Worksheet key order.

preview_token
string<uuid> | null

Optional ignored preview compatibility input; a fresh token is returned.

Example:

"d38103d8-1e8b-47ab-ae04-7e1f8a3bc727"

Response

Review bulk commitment changes completed.

data
object