Skip to main content
PATCH
Change a donation

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The donation's ID.

Body

application/json
amount_cents
integer

The amount in whole cents.

Required range: x >= 1
currency
string
campaign_id
string | null

Null takes the gift off its campaign.

donation_type
enum<string>
Available options:
one_time,
recurring,
post_adoption_bump,
upsell
payment_gateway
enum<string> | null

How the money came.

Available options:
stripe,
paypal,
square,
zelle,
cashapp,
venmo,
other,
null
gateway_reference
object

Replaces the references there were.

status
enum<string>

Only completed gifts count towards a campaign, a donor's giving or the donors list.

Available options:
pending,
completed,
failed,
refunded
donated_at
string<date>

The day of the gift, YYYY-MM-DD.

custom_fields
object

Merged into the values there are. A key that is not one of your fields is refused.

department_id
string | null

Changes the department; null takes it off.

Response

The donation, as it now is.

id
string
required
amount_cents
integer
required

The amount in whole cents: 5000 is $50.00.

currency
string
required
donation_type
enum<string>
required
Available options:
one_time,
recurring,
post_adoption_bump,
upsell
status
enum<string>
required

Only completed gifts count towards a campaign, a donor's giving or the donors list.

Available options:
pending,
completed,
failed,
refunded
donated_at
string
required

The day of the gift, YYYY-MM-DD.

created_at
string<date-time>
required

When it was recorded.

updated_at
string<date-time>
required
tenant_id
string

Your organization's ID.

person_id
string | null

The donor. Null for an anonymous gift.

campaign_id
string | null
recurring_schedule
object | null
payment_gateway
enum<string> | null

How the money came.

Available options:
stripe,
paypal,
square,
zelle,
cashapp,
venmo,
other,
null
gateway_reference
object
custom_fields
object
fund_id
string | null

The fund the GIVER designated this gift to, if any. See Fund.

appeal_id
string | null

The appeal the organization recorded this gift against, if any. A gift created with an appeal and no campaign takes the appeal's default campaign. See Appeal.

dedication_type
enum<string> | null

Whether this gift is in honor of somebody living or in memory of somebody who has died. A type requires dedication_name, and a name requires a type: both halves are refused on their own, because "in memory of" with nobody named cannot be written on a receipt.

Available options:
honor,
memory,
null
dedication_name
string | null

Who the gift is for. Often an animal.

Maximum string length: 200
dedication_note
string | null

What the giver asked to be said, as they typed it.

Maximum string length: 2000
dedication_notify_email
string | null

Somebody to tell, when the giver asked for that. A gift taken through the organization’s own donation form emails them once the money has gone through; a gift recorded through this API or by hand does not.

dedication_notified_at
string<date-time> | null

When that note went out. Read only.

fair_market_value_cents
integer | null

The value of goods or services the donor received, in whole cents. THREE STATES, NOT TWO: null means nobody has recorded a value and a receipt says nothing either way; 0 means the donor received nothing in return; a number means they received goods or services worth that. Only written when the key is present in the body, so a request about something else never turns one into the other.

Required range: x >= 0
donor_first_name
string | null

The giver's FIRST name, on the list only, for a screen projected at an event. Never a surname: a room full of strangers is the most public place a gift appears. Null for a gift with no person on it.

donor_name
string | null

On the list only: the giver's whole name, or their email address when they have no name on file. Null for a gift with no person on it.

fundraising_page_id
string | null

The supporter's or team's fundraising page the gift was given on, if any. The gift counts for the page and for its campaign.

department_id
string | null

The part of the rescue it belongs to: the one it was given, else its campaign's, else your default for gifts. Copied when the gift is recorded, so a campaign changed later leaves it as it is.