Skip to main content
POST
Import donations

Authorizations

Authorization
string
header
required

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

Body

application/json
rows
object[]
required

One object per gift. Errors name the line as a spreadsheet would: the first row is line 2, after the header.

Required array length: 1 - 2000 elements
dry_run
boolean
default:false

Check the rows and say what would happen, recording nothing.

Response

What was recorded, or on a dry run what would be. A dry run that finds problems still answers 200, with the problems in errors.

dry_run
boolean
total_rows
integer
would_create
integer

How many gifts the rows make, leaving out the skipped ones.

created
integer

How many were recorded. 0 on a dry run and whenever there are errors.

skipped
object[]

Rows whose external_id is already on one of your gifts.

errors
object[]
total_cents
integer

The sum of the gifts the rows make, in whole cents.

can_detect_duplicates
boolean

Whether any row has an external_id. When false, importing the same rows again records them again.

preview
object[]

The first ten gifts the rows make.