Funds

The Fundraise API allows to manage comprehensive fundraising activities by handling funds (base entity for collecting money), campaigns (targeted fundraising initiatives tied to specific funds), pledges (promises for future donations), and actual donations. Create and track multiple fundraising campaigns simultaneously, each connected to one or more funds, while managing incoming donations and pledges.

Endpoints

The Pledge object

A pledge represents a promised future donation to a fund, tracking the committed amount and optional target date for fulfillment, with the applications array recording when and how much of the pledge has been fulfilled through actual donations. Other than donations, pledges applications will only be set when a donation is created that fulfills the pledge. The applications will be handled automatically and are not allowed to be set by payload.

Attributes

_id

Required

string

The ID of the Pledge

amount

Required

number

The amount of the pledge

currency

Required

string

The currency of the pledge (will be automatically set using the seller's currency)

EURUSDGBPAUDCHFTHBILSCOPMXNDKKNOKSEKQARCADISKGTQINRDOPSGDPLNSARTTDZARKYDHKDCZKKRWJPYNZDAEDMADTWDBRLBWP

customerId

Required

string

The ID of the customer of the pledge

fundId

Required

string

The ID of the fund of the pledge

sellerId

Required

string

The ID of the seller owning the pledge

createdAt

Required

string date-time

An ISO timestamp indicating when the pledge was created.

updatedAt

Required

string date-time

An ISO timestamp indicating when the pledge was updated.

Optional Attributes

Collapse all

applications

Optional

array

An array of donations that have fulfilled this pledge.

applications[].donationId

Required

string

An ISO timestamp indicating when the application was applied.

applications[].amount

Required

number

The amount of the donation that was applied to the pledge.

applications[].appliedAt

Required

string date-time

An ISO timestamp indicating when the application was applied.

campaignId

Optional

string

The ID of the campaign of the pledge

salesChannelId

Optional

string

The ID of the sales channel of the pledge

notes

Optional

string

The notes of the pledge

targetDate

Optional

string date-time

An ISO timestamp indicating when the pledge is planned to be fulfilled.

externalId

Optional

string

The external ID of the pledge

pledgedAt

Optional

string date-time

An ISO timestamp indicating when the pledge was pledged. (esp. helpful for pledges from external integrations)

Was this section helpful?

Yes No

{
  "_id": "string",
  "amount": 1,
  "currency": "EUR",
  "applications": [
    {
      "donationId": "string",
      "amount": 1,
      "appliedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "customerId": "string",
  "fundId": "string",
  "campaignId": "string",
  "salesChannelId": "string",
  "notes": "string",
  "targetDate": "2030-01-23T23:00:00.123Z",
  "externalId": "string",
  "pledgedAt": "2030-01-23T23:00:00.123Z",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Create a Pledge

Payload

amount

Required

number

The amount of the pledge

fundId

Required

string

The ID of the fund of the pledge

customerId

Required

string

The ID of the customer of the pledge

Optional Attributes

Collapse all

campaignId

Optional

string

The ID of the campaign of the pledge

salesChannelId

Optional

string

The ID of the sales channel of the pledge

notes

Optional

string

The notes of the pledge

targetDate

Optional

string date-time

An ISO timestamp indicating when the pledge is planned to be fulfilled.

externalId

Optional

string

The external ID of the pledge

pledgedAt

Optional

string date-time

An ISO timestamp indicating when the pledge was pledged. (esp. helpful for pledges from external integrations)

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "amount": 1,
  "campaignId": "string",
  "fundId": "string",
  "customerId": "string",
  "salesChannelId": "string",
  "notes": "string",
  "targetDate": "2030-01-23T23:00:00.123Z",
  "externalId": "string",
  "pledgedAt": "2030-01-23T23:00:00.123Z"
}

{
  "_id": "string",
  "amount": 1,
  "currency": "EUR",
  "applications": [
    {
      "donationId": "string",
      "amount": 1,
      "appliedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "customerId": "string",
  "fundId": "string",
  "campaignId": "string",
  "salesChannelId": "string",
  "notes": "string",
  "targetDate": "2030-01-23T23:00:00.123Z",
  "externalId": "string",
  "pledgedAt": "2030-01-23T23:00:00.123Z",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get a Pledge

Parameter

Required

The ID or external ID of the pledge to retrieve. In case of external ID, the external ID must be prefixed with 'externalId:'.

Query

No supported query parameters

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "_id": "string",
  "amount": 1,
  "currency": "EUR",
  "applications": [
    {
      "donationId": "string",
      "amount": 1,
      "appliedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "customerId": "string",
  "fundId": "string",
  "campaignId": "string",
  "salesChannelId": "string",
  "notes": "string",
  "targetDate": "2030-01-23T23:00:00.123Z",
  "externalId": "string",
  "pledgedAt": "2030-01-23T23:00:00.123Z",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}