Skip to main content
POST
Prepare a lost-donor reactivation action

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

bucket
string
required

Cohort bucket key. Only lost_donors permits reactivation.

Body

application/json

Validated request fields for this operation.

acknowledgement_work_scope
enum<string> | null

Acknowledgement work scope. Validation: nullable; allowed values: active, historical, all.

Available options:
active,
historical,
all,
null
Example:

"active"

fundraiser_user_id
string | null

Relationship-manager id, all or unassigned; scoped by donor visibility.

Maximum string length: 64
Example:

"all"

group_by_household
boolean | null

Boolean-like query input; true/false and numeric forms are normalized by this workflow.

Example:

false

search
string | null

Search. Validation: nullable, string, max:255.

Maximum string length: 255
Example:

"education"

date_from
string<date-time> | null

Date from. Validation: nullable, date.

Example:

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

date_to
string<date-time> | null

Date to. Validation: nullable, date.

Example:

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

state
string | null

State. Validation: nullable, string, max:64.

Maximum string length: 64
Example:

"State"

comparison_mode
string | null

Comparison mode. Validation: nullable, string, max:64.

Maximum string length: 64
Example:

"Comparison Mode"

current_start
string<date-time> | null

Current start. Validation: nullable, date.

Example:

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

current_end
string<date-time> | null

Current end. Validation: nullable, date.

Example:

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

comparison_start
string<date-time> | null

Comparison start. Validation: nullable, date.

Example:

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

comparison_end
string<date-time> | null

Comparison end. Validation: nullable, date.

Example:

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

refresh
boolean | null

Boolean-like query input; true/false and numeric forms are normalized by this workflow.

Example:

false

page
integer | null

Page. Validation: nullable, integer, min:1.

Required range: x >= 1
Example:

1

per_page
integer | null

Per page. Validation: nullable, integer, min:10, max:100.

Required range: 10 <= x <= 100
Example:

10

action
string | null

Action. Validation: nullable, string, max:64.

Maximum string length: 64
Example:

"Action"

due_date
string<date-time> | null

Due date. Validation: nullable, date.

Example:

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

owner_user_id
integer | null

Owner user id. Validation: nullable, integer.

Example:

1

audience_name
string | null

Audience name. Validation: nullable, string, max:255.

Maximum string length: 255
Example:

"Audience Name"

Response

Operation result.

status
string
Example:

"success"

data
object

May return only a prepared audience, install a saved view or create deduplicated Work, depending on enabled action; never sends outreach.