Donors

Creates a new donor record that does not already exist.

This method will auto-generate an ID and create a new donor. If an ID is specified for the donor, an error will be thrown.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The donor that you would like to be saved.

id required	string (ID) /^[\w-\|:]+$/ The unique, string identifier of this donor
type required	string (Type) The donor type Enum: "contact" "organization"
organization_id required	string (Organization) The organization for this donor
contact_id required	string (Contact) The contact for this donor
donor_club_id	string (Donor Club) The donor level
date_of_last_gift	string (Date Of Last Gift) The date the last gift was given
total_number_of_gifts	number <float> (Total Number Of Gifts) Total # of gifts given
total_amount_of_gifts	number <float> (Total Amount Of Gifts) Total amount/value of gifts given
pledge_balance	number <float> (Pledge Balance) Outstanding balance on pledges
amount_of_largest_gift	number <float> (Amount Of Largest Gift)
	Array of objects
first_name	string (First Name) The member's first name
last_name	string (Last Name) The member's last name
name required	string (Name) The member's name
email_address	string (Email Address) The member's email address
city	string (City) The member city
state	string (State) The state
country	string (Country) The member country
job_title	string (Job Title) The member job title
anonymous	boolean (Anonymous) Set if this donor has requested anonymity
notes	string (Notes) Notes on the donor
	Array of objects (Custom Field Values)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The donor was saved successfully.

400The donor you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The donor could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add donor based on tenant limits.

500General server error.

post/donors/{tenantId}

Request samples

application/json

{"id": "string",
"type": "contact",
"organization_id": "string",
"contact_id": "string",
"donor_club_id": "string",
"date_of_last_gift": "string",
"total_number_of_gifts": 0,
"total_amount_of_gifts": 0,
"pledge_balance": 0,
"amount_of_largest_gift": 0,
"donor_club_history": [{"donor_club_id": "string",
"start_date": "string",
"end_date": "string"
}
],
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"anonymous": true,
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"type": "contact",
"organization_id": "string",
"contact_id": "string",
"donor_club_id": "string",
"date_of_last_gift": "string",
"total_number_of_gifts": 0,
"total_amount_of_gifts": 0,
"pledge_balance": 0,
"amount_of_largest_gift": 0,
"donor_club_history": [{"donor_club_id": "string",
"start_date": "string",
"end_date": "string"
}
],
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"anonymous": true,
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a donor from the system by its ID.

This method will look up a donor by the specified ID and return it back.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the donor to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The donor was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The donor could not be found.

429Limit exceeded... unable to retrieve donor based on tenant limits.

500General server error.

get/donors/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://fundraising.api.756794052567.rhythmsoftware.com/donors/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"type": "contact",
"organization_id": "string",
"contact_id": "string",
"donor_club_id": "string",
"date_of_last_gift": "string",
"total_number_of_gifts": 0,
"total_amount_of_gifts": 0,
"pledge_balance": 0,
"amount_of_largest_gift": 0,
"donor_club_history": [{"donor_club_id": "string",
"start_date": "string",
"end_date": "string"
}
],
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"anonymous": true,
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a donor with the specified ID.

This method will update an existing donor with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the donor to update.

Request Body schema: application/json

The updated donor that will be saved.

id required	string (ID) /^[\w-\|:]+$/ The unique, string identifier of this donor
type required	string (Type) The donor type Enum: "contact" "organization"
organization_id required	string (Organization) The organization for this donor
contact_id required	string (Contact) The contact for this donor
donor_club_id	string (Donor Club) The donor level
date_of_last_gift	string (Date Of Last Gift) The date the last gift was given
total_number_of_gifts	number <float> (Total Number Of Gifts) Total # of gifts given
total_amount_of_gifts	number <float> (Total Amount Of Gifts) Total amount/value of gifts given
pledge_balance	number <float> (Pledge Balance) Outstanding balance on pledges
amount_of_largest_gift	number <float> (Amount Of Largest Gift)
	Array of objects
first_name	string (First Name) The member's first name
last_name	string (Last Name) The member's last name
name required	string (Name) The member's name
email_address	string (Email Address) The member's email address
city	string (City) The member city
state	string (State) The state
country	string (Country) The member country
job_title	string (Job Title) The member job title
anonymous	boolean (Anonymous) Set if this donor has requested anonymity
notes	string (Notes) Notes on the donor
	Array of objects (Custom Field Values)
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The donor was updated successfully.

400The donor supplied was not valid.

401Unauthorized.

403Forbidden.

404The donor could not be found.

409The donor could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve donor based on tenant limits.

500General server error.

put/donors/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"type": "contact",
"organization_id": "string",
"contact_id": "string",
"donor_club_id": "string",
"date_of_last_gift": "string",
"total_number_of_gifts": 0,
"total_amount_of_gifts": 0,
"pledge_balance": 0,
"amount_of_largest_gift": 0,
"donor_club_history": [{"donor_club_id": "string",
"start_date": "string",
"end_date": "string"
}
],
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"anonymous": true,
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"type": "contact",
"organization_id": "string",
"contact_id": "string",
"donor_club_id": "string",
"date_of_last_gift": "string",
"total_number_of_gifts": 0,
"total_amount_of_gifts": 0,
"pledge_balance": 0,
"amount_of_largest_gift": 0,
"donor_club_history": [{"donor_club_id": "string",
"start_date": "string",
"end_date": "string"
}
],
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"anonymous": true,
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a donor with the specified ID.

This method will patch an existing donor with the specified ID, using the HTTP PATCH specification.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the donor to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The donor was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The donor could not be found.

409The donor could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve donor based on tenant limits.

500General server error.

patch/donors/{tenantId}/{id}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"id": "string",
"type": "contact",
"organization_id": "string",
"contact_id": "string",
"donor_club_id": "string",
"date_of_last_gift": "string",
"total_number_of_gifts": 0,
"total_amount_of_gifts": 0,
"pledge_balance": 0,
"amount_of_largest_gift": 0,
"donor_club_history": [{"donor_club_id": "string",
"start_date": "string",
"end_date": "string"
}
],
"first_name": "string",
"last_name": "string",
"name": "string",
"email_address": "string",
"city": "string",
"state": "string",
"country": "string",
"job_title": "string",
"anonymous": true,
"notes": "string",
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a donor from the system by its ID.

This method will delete a donor with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the donor to delete.

Responses

200The donor was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The donor could not be found.

409The donor could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete donor based on tenant limits.

500General server error.

delete/donors/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://fundraising.api.756794052567.rhythmsoftware.com/donors/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"

Searches for donors using predefined parameters

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

exclusiveStartKey	string The start key for the search, for paging support
fieldsToReturn	string The fields that you want to retrieve; if omitted, the entire object is returned

Request Body schema: application/json

The donor that you would like to be saved.

ids	Array of strings (Ids) IDs to search
first_name	string (First Name)
last_name	string (Last Name)
email_address	string (Email Address)
nickname	string (Nickname)
organization_id	Array of strings (Organization)
type	string (Type)
contact_id	Array of strings (Contact)
job_title	string (Job Title)
city	string (City) City to search
state	string (State) The state

Responses

200The donor search was saved successfully.

400The donor you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The donor could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add donor based on tenant limits.

500General server error.

post/donors/{tenantId}/search

Request samples

application/json

{"ids": ["string"
],
"first_name": "string",
"last_name": "string",
"email_address": "string",
"nickname": "string",
"organization_id": ["string"
],
"type": "string",
"contact_id": ["string"
],
"job_title": "string",
"city": "string",
"state": "string"
}

Response samples

application/json

{"Items": [{"id": "string",
"name": "string",
"domain_name": "string",
"city": "string",
"state": "string",
"type": "string",
"organization": "string",
"contact_id": "string"
}
],
"LastEvaluatedKey": "string"
}

Recalculate Totals/Donor Clubs

Goes through and recalculates all donor totals and automatic donor club assignments

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Responses

200The records were retrieved successfully

400The request was not valid.

401Unauthorized.

403Forbidden

404Unable to locate records

429Limit exceeded... unable to retrieve records based on tenant limits.

500General server error

post/donors/{tenantId}/recalculateDonorTotals

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X POST \
  https://fundraising.api.756794052567.rhythmsoftware.com/donors/:tenantId/recalculateDonorTotals \
  -H 'Authorization: YOUR_API_KEY_HERE'

Execute Batch Operations

TAllows you to perform up to 100 parallel patch/delete operations

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The donor could not be found.

429Limit exceeded... unable to retrieve donor based on tenant limits.

500General server error.

post/donors/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}