Update contribution

Replace a contribution with the supplied values. This is a full update: omitted fields are cleared, with two exceptions. Soft credits are replaced only when a non-empty list is sent, so they cannot be removed through this endpoint, and files only links additional documents to the contribution, never unlinks existing ones. Gateway-processed contributions allow only a limited set of edits (e.g. notes and confirmation number), and the amount and designations of a refund or of a contribution posted to accounting cannot be changed. First retrieve the current contribution from /api/contributions/{id}, apply your changes, then send back the full object. Editing a contribution in another user's batch requires the Full Write Contributions or Unrestricted Batches permission.

Required permission: Limited Write Contributions

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int32
required
≥ 1

The id of the contribution

Body Params

The new version of the contribution

allocations
array of objects | null
required

The line-item allocations of the gift across designations.

allocations*
type
object | null
required

The contributor type: 1 = anonymous, 2 = person, 3 = business/external.

date-time | null

When the transaction occurred.

method
object | null

The payment method (e.g. card, cash, check).

business
object | null

A reference to a record by its id and display name.

person
object | null

A reference to an existing record by its id.

string | null

Free-text notes on the transaction.

string | null

The check number, when paid by check.

string | null

The bank routing number. Saved only when paid by check; for online payments it is set by the gateway and masked to the last 4 digits.

string | null

The bank account number. Saved only when paid by check; for online payments it is set by the gateway and masked to the last 4 digits.

string | null

The last 4 digits of the card number, when paid by card.

string | null

The gateway/processor confirmation number.

files
array of objects | null

Files attached to the transaction.

files
boolean | null

Whether the notes are shown on the contributor's statement.

string | null

The contributor's display name.

string | null

The contributor's email address as captured on the gift.

string | null

The contributor's phone number as captured on the gift.

address
object | null

The address captured on the gift.

double | null

The processing fees charged, expressed as a negative amount.

softCredits
array of objects | null

The soft credits attributed to this transaction.

softCredits
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses
200

OK

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json