API ReferenceDonors

Update a donor.

Only the fields present in the request body change; anything omitted is left alone. Send dry_run to validate the request without saving it.

Authentication

X-Spring-API-Keystring
Secret API key issued per institution. Send it on every request.

Path parameters

idintegerRequired

Request

This endpoint expects an object.
emailstring or nullOptional
first_namestring or nullOptional
last_namestring or nullOptional
phonestring or nullOptional
organizationstring or nullOptional
address1string or nullOptional
address2string or nullOptional
citystring or nullOptional
statestring or nullOptional
countystring or nullOptional
zip_codestring or nullOptional
countryinteger or nullOptional
job_titlestring or nullOptional
work_emailstring or nullOptional
work_phonestring or nullOptional
company_namestring or nullOptional
public_first_namestring or nullOptional
public_last_namestring or nullOptional
public_organization_namestring or nullOptional
websitestring or nullOptional
facebook_urlstring or nullOptional
twitter_urlstring or nullOptional
linked_in_urlstring or nullOptional
descriptionstring or nullOptional
notesstring or nullOptional
make_profile_privateboolean or nullOptional
include_soft_creditsboolean or nullOptional

Response

OK
objectstring or nullOptionalRead-only

Stripe-style resource discriminator. Stable, snake_case string naming the resource type. Serialized first so it reads as the leading field of every V1 resource body.

idintegerOptional
first_namestring or nullOptional
last_namestring or nullOptional
emailstring or nullOptional
phonestring or nullOptional
roleenum or nullOptional

Whether this is an individual donor or a donor organization: Individual or Organization. Mirrors the role field on the create request.

date_of_birthdatetime or nullOptional
birth_monthstring or nullOptional
birth_dayinteger or nullOptional
birth_yearinteger or nullOptional
address1string or nullOptional
address2string or nullOptional
citystring or nullOptional
statestring or nullOptional
countystring or nullOptional
zip_codestring or nullOptional
countryinteger or nullOptional
job_titlestring or nullOptional
work_emailstring or nullOptional
work_phonestring or nullOptional
company_namestring or nullOptional
organization_namestring or nullOptional
public_organization_namestring or nullOptional
make_profile_privateboolean or nullOptional
public_first_namestring or nullOptional
public_last_namestring or nullOptional
websitestring or nullOptional
facebook_urlstring or nullOptional
twitter_urlstring or nullOptional
linked_in_urlstring or nullOptional
photo_urlstring or nullOptional
descriptionstring or nullOptional
notesstring or nullOptional
include_soft_creditsbooleanOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error