Skip to main content
PATCH
Bulk-edit fields across many donors (async)

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json
donor_ids
required

Either an array of donor IDs or the literal string all. Validation rule: required.

Example:
values
object
required

Map of field name to new value to apply to every targeted donor. Keys may be standardized columns (e.g. first_name, phone) or custom keys defined in the donor form's json_fields schema. When clear_fields is true, clear_field_keys drives which fields are cleared; values may still carry real entries for the other, non-cleared selected fields in the same request, and a key present in both is cleared.

Example:
clear_fields
boolean

When true, clears every field listed in clear_field_keys in addition to applying any other entered values.

Example:

false

clear_field_keys
string[]

Field keys to set empty when clear_fields is true.

Example:
confirm_identity_transition
boolean

Required and must be true when values.type changes donor profile type.

Example:

true

hysform_id
integer

Required when donor_ids is all — the donor form whose donors should be selected.

Example:

42

client_id
integer

Legacy client hint ignored by the controller; donor selection is scoped to the authenticated client.

Example:

207

Response

Bulk-edit jobs dispatched.

message
string
Example:

"Donors are being edited"