Pledges

Creates a new pledge record that does not already exist.

This method will auto-generate an ID and create a new pledge. If an ID is specified for the pledge, 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 pledge that you would like to be saved.

id required	string (ID) /^[\w:\|-]+$/ The unique, string identifier of this pledge
amount required	number <float> (Amount) Gift amount
currency_code	string (Currency Code) The currency code of the gift
currency_symbol	string (Currency Symbol) Currency
donor_type required	string (Donor Type) The donor type for the gift Enum: "contact" "organization"
contact_id required	string (Contact) The rolodex contact id for the gift giver
organization_id required	string (Organization) The organization id associated with this gift
giving_process_id	string (Giving Process) The process of that led to the gift
fund_id required	string (Fund) The id for the fund associated with the gift
tribute_gift	boolean (Tribute Gift) Whether or not this is a tribute gift
	object (Tribute Gift Info)
anonymous	boolean (Anonymous) Anonymous
campaign_id	string (Campaign) The id for the campaign associated with the gift
appeal_id	string (Appeal) The id for the appeal associated with the gift
notes	string (Notes) Notes about the gift
premium_assignment	string (Premium Assignment) Enum: "not applicable" "assigned" "declined by donor"
premium_id	string (Premium) If the user has selected a premium it is here
premium_fair_market_value	number <float> (Premium Fair Market Value) The amount of any premiums associated with the gift
has_splits	boolean (Has Splits) If true, this gift is split into different funds
	Array of objects An array of fund allocations for this gift
cover_transaction_costs	boolean (Cover Transaction Costs) If selected, the donor covers the transaction fees
	object (Address) A complete address
installment_plan_id required	string (Installment Plan) The installment plan for the pledge
	Array of objects (Custom Field Values)
date	string <date-time> (Date) The creation date for the gift
number	number <float> (Number) The gift number
donor_id required	string (Donor) The donor record associated with this gift
order_id	string (Order) The id for the order associated with the gift
order_line_item_id	string (Order Line Item) The id for the order line item associated with the gift
amount_allocated_to_primary_fund required	number <float> (Amount Allocated To Primary Fund) When gift is split, this is the amount that is allocated to the primary fund
amount_allocated_to_splits required	number <float> (Amount Allocated To Splits) When gift is split, this is the amount that is allocated to splits
tax_deductible_amount required	number <float> (Tax Deductible Amount) The amount of the gift less any premiums
has_soft_credits	boolean (Has Soft Credits) If true, this gift has soft credits to others
required	Array of objects non-empty
status required	string (Status) The status of the pledge Enum: "open" "paid" "cancelled" "paused"
	object (Payment Info) Payment information for the recurring gift
amount_fulfilled required	number <float> (Amount Fulfilled) Amount of pledge fulfilled
remaining_payments required	number <float> (Remaining Payments) The number of payments remaining on the pledge
amount_outstanding required	number <float> (Amount Outstanding) The amount of outstanding on the pledge
next_payment_date	string (Next Payment Date) The next processing date of the pledge
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 pledge was saved successfully.

400The pledge you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/pledges/{tenantId}

Request samples

application/json

{"id": "string",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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 pledge from the system by its ID.

This method will look up a pledge 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 pledge 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 pledge was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The pledge could not be found.

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

500General server error.

get/pledges/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"id": "string",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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 pledge with the specified ID.

This method will update an existing pledge 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 pledge to update.

Request Body schema: application/json

The updated pledge that will be saved.

id required	string (ID) /^[\w:\|-]+$/ The unique, string identifier of this pledge
amount required	number <float> (Amount) Gift amount
currency_code	string (Currency Code) The currency code of the gift
currency_symbol	string (Currency Symbol) Currency
donor_type required	string (Donor Type) The donor type for the gift Enum: "contact" "organization"
contact_id required	string (Contact) The rolodex contact id for the gift giver
organization_id required	string (Organization) The organization id associated with this gift
giving_process_id	string (Giving Process) The process of that led to the gift
fund_id required	string (Fund) The id for the fund associated with the gift
tribute_gift	boolean (Tribute Gift) Whether or not this is a tribute gift
	object (Tribute Gift Info)
anonymous	boolean (Anonymous) Anonymous
campaign_id	string (Campaign) The id for the campaign associated with the gift
appeal_id	string (Appeal) The id for the appeal associated with the gift
notes	string (Notes) Notes about the gift
premium_assignment	string (Premium Assignment) Enum: "not applicable" "assigned" "declined by donor"
premium_id	string (Premium) If the user has selected a premium it is here
premium_fair_market_value	number <float> (Premium Fair Market Value) The amount of any premiums associated with the gift
has_splits	boolean (Has Splits) If true, this gift is split into different funds
	Array of objects An array of fund allocations for this gift
cover_transaction_costs	boolean (Cover Transaction Costs) If selected, the donor covers the transaction fees
	object (Address) A complete address
installment_plan_id required	string (Installment Plan) The installment plan for the pledge
	Array of objects (Custom Field Values)
date	string <date-time> (Date) The creation date for the gift
number	number <float> (Number) The gift number
donor_id required	string (Donor) The donor record associated with this gift
order_id	string (Order) The id for the order associated with the gift
order_line_item_id	string (Order Line Item) The id for the order line item associated with the gift
amount_allocated_to_primary_fund required	number <float> (Amount Allocated To Primary Fund) When gift is split, this is the amount that is allocated to the primary fund
amount_allocated_to_splits required	number <float> (Amount Allocated To Splits) When gift is split, this is the amount that is allocated to splits
tax_deductible_amount required	number <float> (Tax Deductible Amount) The amount of the gift less any premiums
has_soft_credits	boolean (Has Soft Credits) If true, this gift has soft credits to others
required	Array of objects non-empty
status required	string (Status) The status of the pledge Enum: "open" "paid" "cancelled" "paused"
	object (Payment Info) Payment information for the recurring gift
amount_fulfilled required	number <float> (Amount Fulfilled) Amount of pledge fulfilled
remaining_payments required	number <float> (Remaining Payments) The number of payments remaining on the pledge
amount_outstanding required	number <float> (Amount Outstanding) The amount of outstanding on the pledge
next_payment_date	string (Next Payment Date) The next processing date of the pledge
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 pledge was updated successfully.

400The pledge supplied was not valid.

401Unauthorized.

403Forbidden.

404The pledge could not be found.

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

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

500General server error.

put/pledges/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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 pledge with the specified ID.

This method will patch an existing pledge 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 pledge 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 pledge was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The pledge could not be found.

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

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

500General server error.

patch/pledges/{tenantId}/{id}

Request samples

application/json

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

Response samples

application/json

{"id": "string",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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 pledge from the system by its ID.

This method will delete a pledge 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 pledge to delete.

Responses

200The pledge was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The pledge could not be found.

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

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

500General server error.

delete/pledges/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

"string"

Returns a list of records with the specified contact_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
contact_id required	string The contact_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

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

get/pledges/{tenantId}/contact/{contact_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://fundraising.api.756794052567.rhythmsoftware.com/pledges/:tenantId/contact/:contact_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified organization_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
organization_id required	string The organization_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

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

get/pledges/{tenantId}/organization/{organization_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://fundraising.api.756794052567.rhythmsoftware.com/pledges/:tenantId/organization/:organization_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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"
}
]
}
],
"LastEvaluatedKey": "string"
}

Searches for pledges 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 pledge that you would like to be saved.

status	Array of strings (Status) Recurring gift ids to search
ids	Array of strings (Ids) IDs to search
type	Array of strings (Type) Types of the gifts
contact_id	Array of strings (Contact) Contact ids for the donor
organization_id	Array of strings (Organization) Organization ids for the donor
order_id	Array of strings (Order) Order ids to search
campaign_id	Array of strings (Campaign) Campaign ids to search
fund_id	Array of strings (Fund) Fund ids to search
appeal_id	Array of strings (Appeal) Appeal ids to search
date	Array of strings <date-time> (Date) 2 items

Responses

200The pledge search was saved successfully.

400The pledge you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

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

500General server error.

post/pledges/{tenantId}/search

Request samples

application/json

{"status": ["string"
],
"ids": ["string"
],
"type": ["string"
],
"contact_id": ["string"
],
"organization_id": ["string"
],
"order_id": ["string"
],
"campaign_id": ["string"
],
"fund_id": ["string"
],
"appeal_id": ["string"
],
"date": ["2019-08-24T14:15:22Z",
"2019-08-24T14:15:22Z"
]
}

Response samples

application/json

{"Items": [{"status": "string",
"id": "string",
"type": "string",
"contact_id": "string",
"organization_id": "string",
"order_id": "string",
"campaign_id": "string",
"fund_id": "string",
"appeal_id": "string",
"date": "string"
}
],
"LastEvaluatedKey": "string"
}

Sends out a preview of the pledge notification email

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

pledge_id	string (Pledge)
	object (Email Template)
destination_email_address required	string (Destination Email Address)
recurring_gift_id required	string (Recurring Gift)

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

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

500General server error

post/pledges/{tenantId}/previewEmail

Request samples

application/json

{"pledge_id": "string",
"email_template": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"destination_email_address": "string",
"recurring_gift_id": "string"
}

Generates an order from a fundraising pledge

This method will examine a fundraising pledge and generate an appropriate order

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed

Request Body schema: application/json

The pledge to generate an order

amount required	number <float> (Amount) Gift amount
currency_code	string (Currency Code) The currency code of the gift
currency_symbol	string (Currency Symbol) Currency
donor_type required	string (Donor Type) The donor type for the gift Enum: "contact" "organization"
contact_id required	string (Contact) The rolodex contact id for the gift giver
organization_id required	string (Organization) The organization id associated with this gift
giving_process_id	string (Giving Process) The process of that led to the gift
fund_id required	string (Fund) The id for the fund associated with the gift
tribute_gift	boolean (Tribute Gift) Whether or not this is a tribute gift
	object (Tribute Gift Info)
anonymous	boolean (Anonymous) Anonymous
campaign_id	string (Campaign) The id for the campaign associated with the gift
appeal_id	string (Appeal) The id for the appeal associated with the gift
notes	string (Notes) Notes about the gift
premium_assignment	string (Premium Assignment) Enum: "not applicable" "assigned" "declined by donor"
premium_id	string (Premium) If the user has selected a premium it is here
premium_fair_market_value	number <float> (Premium Fair Market Value) The amount of any premiums associated with the gift
has_splits	boolean (Has Splits) If true, this gift is split into different funds
	Array of objects An array of fund allocations for this gift
cover_transaction_costs	boolean (Cover Transaction Costs) If selected, the donor covers the transaction fees
	object (Address) A complete address
installment_plan_id required	string (Installment Plan) The installment plan for the pledge
	Array of objects (Custom Field Values)

Responses

200Conflicts were retrieved successfully

400The search you supplied was invalid.

401Unauthorized

403Forbidden

404The resource could not be found

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

500General server error

post/pledges/{tenantId}/generateOrder

Request samples

application/json

{"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
]
}

Response samples

application/json

{ }

Preview Pledge Receipt

Sends out a preview of the pledge receipt email

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

gift_id	string (Gift)
	object (Email Template)
destination_email_address required	string (Destination Email Address)
pledge_id required	string (Pledge)

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

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

500General server error

post/pledges/{tenantId}/previewReceipt

Request samples

application/json

{"gift_id": "string",
"email_template": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"destination_email_address": "string",
"pledge_id": "string"
}

Resend Receipt

Resends the pledge receipt

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
id required	string The ID of the pledge

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

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

500General server error

post/pledges/{tenantId}/resendReceipt/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Resend Receipt

Resends the pledge receipt

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

Payload for the pledge

required	object (Pledge Payload)
donor_info	object (Donor Info) Optional info for public pledges
electronic_payment_info	object (Electronic Payment Info) The payment info

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

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

500General server error

post/pledges/{tenantId}/process

Request samples

application/json

{"pledge_payload": {"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
]
},
"donor_info": { },
"electronic_payment_info": { }
}

Response samples

application/json

{"notification_publishKey": "string",
"notification_subscribeKey": "string",
"notification_channel": "string",
"executionArn": "string",
"start_date": "2019-08-24T14:15:22Z"
}

Resend Receipt

Resends the pledge receipt

Request

path Parameters

tenantId

required

string

The tenant

Request Body schema: application/json

Payload for the pledge

required	object (Pledge Payload)
donor_info	object (Donor Info) Optional info for public pledges
electronic_payment_info	object (Electronic Payment Info) The payment info

Responses

200The record was retrieved successfully

400The request was not valid.

401Unauthorized

403Forbidden

404Unable to locate any organizations with the specified domain

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

500General server error

post/pledges/{tenantId}/public/process

Request samples

application/json

{"pledge_payload": {"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
]
},
"donor_info": { },
"electronic_payment_info": { }
}

Response samples

application/json

{"notification_publishKey": "string",
"notification_subscribeKey": "string",
"notification_channel": "string",
"executionArn": "string",
"start_date": "2019-08-24T14:15:22Z"
}

Returns a list of records with the specified donor_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
donor_id required	string The donor_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

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

get/pledges/{tenantId}/donor/{donor_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://fundraising.api.756794052567.rhythmsoftware.com/pledges/:tenantId/donor/:donor_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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"
}
]
}
],
"LastEvaluatedKey": "string"
}

Returns a list of records with the specified order_id

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The tenant
order_id required	string The order_id to use to for record lookup

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned
exclusiveStartKey	string If paging, this allows you to return the next set of results

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

get/pledges/{tenantId}/order/{order_id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://fundraising.api.756794052567.rhythmsoftware.com/pledges/:tenantId/order/:order_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"Count": 0,
"Items": [{"id": "string",
"amount": 0,
"currency_code": "string",
"currency_symbol": "string",
"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"giving_process_id": "string",
"fund_id": "string",
"tribute_gift": true,
"tribute_gift_info": {"type": "in memory of",
"name": "string",
"contact_id": "string",
"details": "string",
"inform_honoree": true,
"inform_honoree_by": "email",
"email_address": "user@example.com",
"address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"message": "string"
},
"anonymous": true,
"campaign_id": "string",
"appeal_id": "string",
"notes": "string",
"premium_assignment": "not applicable",
"premium_id": "string",
"premium_fair_market_value": 0,
"has_splits": true,
"splits": [{"fund_id": "string",
"amount": 0
}
],
"cover_transaction_costs": true,
"shipping_address": {"line1": "string",
"line2": "string",
"line3": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"county": "string",
"country": "string",
"latitude": 0,
"longitude": 0,
"time_zone_id": "string"
},
"installment_plan_id": "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": [{ }
]
}
],
"date": "2019-08-24T14:15:22Z",
"number": 0,
"donor_id": "string",
"order_id": "string",
"order_line_item_id": "string",
"amount_allocated_to_primary_fund": 0,
"amount_allocated_to_splits": 0,
"tax_deductible_amount": 0,
"has_soft_credits": true,
"soft_credits": [{"donor_type": "contact",
"contact_id": "string",
"organization_id": "string",
"fund_id": "string",
"percentage": 100,
"amount": 0,
"reason": "matching"
}
],
"status": "open",
"payment_info": {"payment_origin": "ad hoc",
"payment_account": "string",
"card_type": "american express",
"card_expiration": "string",
"merchant_account_tokens": [{"merchant_account_id": "string",
"token": "string"
}
],
"type": "credit card"
},
"amount_fulfilled": 0,
"remaining_payments": 0,
"amount_outstanding": 0,
"next_payment_date": "string",
"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"
}
]
}
],
"LastEvaluatedKey": "string"
}

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 pledge could not be found.

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

500General server error.

post/pledges/{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": { }
}
]
}