Skip to main content
PATCH
Edit a recipient

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Recipient identity, writable system fields, and configured custom form fields.

entity_id
integer
required

ID of the recipient to edit. The legacy entity field is accepted as an alias.

Example:

123

is_visible
enum<integer>

Numeric public visibility flag; 1 includes the recipient on public sponsorship pages and 0 hides it.

Available options:
0,
1
Example:

1

Features the recipient where the program supports featured placement.

Example:

false

email
string<email> | null

Portal email address; null or empty clears the existing address.

Example:

"recipient@example.org"

sp_num
number

Sponsorship threshold for the recipient; changing the value recalculates sponsorship status.

Example:

3

sp_amount

Sponsorship amount as a number or numeric string; an empty string or null clears it. Changing the value recalculates sponsorship status.

Example:

40

tags

Tag names as an array or comma-separated string. Individual tag names may not contain commas; null clears the tags.

Example:
donor_dashboard_visibility
enum<string>

Controls the recipient's availability for additional gifts on donor dashboards.

Available options:
previous_donors,
all_donors,
hidden
Example:

"previous_donors"

waiting_days
integer

Manual days waiting. Supply this or waiting_since, never both; only eligible number or contribution recipients can change waiting time.

Required range: 0 <= x <= 365000
Example:

30

waiting_since
string<date>

Manual waiting-since date in organization time; must not be in the future. Mutually exclusive with waiting_days.

Example:

"2026-09-20"

Response

Recipient profile saved

message
string
Example:

"Profile saved"

waiting_since
string<date> | null
Example:

"2026-09-20"

waiting_days
integer | null
Example:

30

is_waiting
boolean | null
Example:

true