Skip to navigation

Partially update an existing donor.

This endpoint performs a partial update of the donor record. Only fields that are provided (non-null) in the request will be updated. All other fields will remain unchanged. This is useful when you only want to update specific fields without providing the entire donor object.

Authentication

Authorizationstring

JWT Authorization header using the Bearer scheme. Example: “Authorization: Bearer {token}”

Path parameters

idlongRequired
The ID of the donor to update.

Request

The partial donor information to update. Only non-null fields will be updated.

titlestring or nullOptional<=75 characters
Gets or sets the title. If set, updates the donor's title.
firstNamestring or nullOptional<=75 characters
Gets or sets the first name. If set, updates the donor's first name.
middleNamestring or nullOptional<=75 characters
Gets or sets the middle name. If set, updates the donor's middle name.
lastNamestring or nullOptional<=75 characters
Gets or sets the last name. If set, updates the donor's last name.
suffixstring or nullOptional<=75 characters
Gets or sets the suffix. If set, updates the donor's suffix.
emailstring or nullOptionalformat: "email"<=150 characters
Gets or sets the email address. If set, updates the donor's email.
phonestring or nullOptional<=50 characters
Gets or sets the phone. If set, updates the donor's phone number.
notesstring or nullOptional
Gets or sets any additional notes. If set, updates the donor's notes.
isOrganizationboolean or nullOptional
Gets or sets a value indicating whether this is an organization. If set, updates the IsOrganization flag.
organizationNamestring or nullOptional<=150 characters
Gets or sets the organization name. If set, updates the donor's organization name.
crmKeysmap from strings to strings or nullOptional
Gets or sets the collection of CRM keys. If set, updates the donor's CRM keys.

Response

OK
idlongOptional
Gets or sets the identifier.
namestring or nullOptional
Gets or sets the name.
titlestring or nullOptional
Gets or sets the title.
firstNamestring or nullOptional
Gets or sets the first name.
middleNamestring or nullOptional
Gets or sets the middle name.
lastNamestring or nullOptional
Gets or sets the last name.
suffixstring or nullOptional
Gets or sets the suffix.
emailstring or nullOptional
Gets or sets the email address.
phonestring or nullOptional
Gets or sets the phone.
createdDatestring or nullOptional
Gets or sets the created date.
modifiedDatestring or nullOptionalRead-only
Gets or sets the modified date.
notesstring or nullOptional
Gets or sets any additional notes.
isOrganizationbooleanOptional
Gets or sets a value indicating whether organization.
organizationNamestring or nullOptional
Gets or sets the organization name.
crmKeyUrlsmap from strings to objects or nullOptional
Gets or sets the CRM URLs by integration type.
crmKeystring or nullOptional
Gets or sets the crmkey.
crmSecondKeystring or nullOptional
Gets or sets the crmsecond key.
isTestModebooleanOptional
Gets or sets a value indicating whether test mode.
isArchivedbooleanOptional
Gets or sets a value indicating whether archived.
isGDPRDeletedbooleanOptional
Gets or sets a value indicating whether gdprdeleted.
primaryAddressobject or nullOptional
Gets or sets the address.
donorAddresseslist of objects or nullOptional
Gets or sets the donor addresses.
donorEmailAddresseslist of objects or nullOptional
Gets or sets the donor email addresses.
donorPhoneNumberslist of objects or nullOptional
Gets or sets the donor phone numbers.

Errors

400
Bad Request Error
404
Not Found Error