Fundraising (v1-2025-04-18)

Service providing access to Fundraising resources and features

Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/
https://fundraising.api.rhythmsoftware.com/

Appeals

Appeals

Operations

Billing Templates

Billing Templates

Operations

Campaigns

Campaigns

Operations

Donor Clubs

Donor Clubs

Operations

Donor Levels

Donor Levels

Operations

Donor Statement Templates

Donor Statement Templates

Operations

Donor Statements

Donor Statements

Operations

Donors

Donors

Operations

Fund Categories

Fund Categories

Operations

Funds

Funds

Operations

Gift Notices

Gift Notices

Operations

Gifts

Gifts

Operations

Giving Processes

Giving Processes

Operations

Pledge Levels

Pledge Levels

Operations

Pledge Notices

Pledge Notices

Operations

Pledges

Pledges

Operations

Returns a list of records with the specified organization_id

Request

Returns a list of records with the specified organization_id

Path
tenantIdstringrequired

The tenant

organization_idstringrequired

The organization_id to use to for record lookup

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned

exclusiveStartKeystring

If paging, this allows you to return the next set of results

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/organization/{organization_id}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The records were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
Countinteger
ItemsArray of objects(Pledge)
LastEvaluatedKeystring
Response
application/json
{ "Count": 0, "Items": [ {} ], "LastEvaluatedKey": "string" }

Sends out a preview of the pledge notification email

Request

Sends out a preview of the pledge notification email

Path
tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

destination_email_addressstring(Destination Email Address)required
email_templateobject(Email Template)
pledge_idstring(Pledge)
recurring_gift_idstring(Recurring Gift)required
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/previewEmail' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "destination_email_address": "string",
    "email_template": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "pledge_id": "string",
    "recurring_gift_id": "string"
  }'

Responses

The record was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Preview Pledge Receipt

Request

Sends out a preview of the pledge receipt email

Path
tenantIdstringrequired

The tenant

Bodyapplication/jsonrequired

The domain_name to use to for record lookup

destination_email_addressstring(Destination Email Address)required
email_templateobject(Email Template)
gift_idstring(Gift)
pledge_idstring(Pledge)required
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/previewReceipt' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "destination_email_address": "string",
    "email_template": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "gift_id": "string",
    "pledge_id": "string"
  }'

Responses

The record was retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring

Premiums

Premiums

Operations

Products

Products

Operations

Query Definitions

Query Definitions

Operations

Recurring Gifts

Recurring Gifts

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations