Fundraising

/

/

Searches for pledges using predefined parameters

Fundraising (v1-2025-04-18)

Service providing access to Fundraising resources and features

Download OpenAPI description

fundraising-v1.json

fundraising-v1.yaml

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

Resend Receipt

Request

Resends the pledge receipt

Path

tenantIdstringrequired

The tenant

idstringrequired

The ID of the pledge

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/resendReceipt/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The record was retrieved successfully

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Searches for pledges using predefined parameters

Request

Searches for pledges using predefined parameters

Path

tenantIdstringrequired

The id of the tenant being accessed.

Query

exclusiveStartKeystring

The start key for the search, for paging support

fieldsToReturnstring

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

Bodyapplication/jsonrequired

The pledge that you would like to be saved.

appeal_idArray of strings(Appeal)

Appeal ids to search

campaign_idArray of strings(Campaign)

Campaign ids to search

contact_idArray of strings(Contact)

Contact ids for the donor

dateArray of strings(date-time)(Date)= 2 items

fund_idArray of strings(Fund)

Fund ids to search

idsArray of strings(Ids)

IDs to search

order_idArray of strings(Order)

Order ids to search

organization_idArray of strings(Organization)

Organization ids for the donor

statusArray of strings(Status)

Recurring gift ids to search

typeArray of strings(Type)

Types of the gifts

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/search?exclusiveStartKey=string&fieldsToReturn=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "appeal_id": [
      "string"
    ],
    "campaign_id": [
      "string"
    ],
    "contact_id": [
      "string"
    ],
    "date": [
      "2019-08-24T14:15:22Z",
      "2019-08-24T14:15:22Z"
    ],
    "fund_id": [
      "string"
    ],
    "ids": [
      "string"
    ],
    "order_id": [
      "string"
    ],
    "organization_id": [
      "string"
    ],
    "status": [
      "string"
    ],
    "type": [
      "string"
    ]
  }'

Responses

The pledge search was saved successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

ItemsArray of objects(PledgeSearchResults)

LastEvaluatedKeystring

Response

application/json

{
  "Items": [
    { … }
  ],
  "LastEvaluatedKey": "string"
}

Returns a pledge from the system by its ID.

Request

This method will delete a pledge with the specified ID.

Path

tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the pledge to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/pledges/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The pledge was deleted successfully.

Headers

Access-Control-Allow-Headersstring

Access-Control-Allow-Methodsstring

Access-Control-Allow-Originstring

Bodyapplication/json

string

Response

application/json

"string"

Premiums

Premiums

Operations

Products

Products

Operations

Query Definitions

Query Definitions

Operations

Recurring Gifts

Recurring Gifts

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations