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 Campaign object

A campaign represents a targeted fundraising initiative that can be linked to multiple funds, allowing organizations to run specific fundraising drives with optional financial targets and deadlines. Each campaign can be associated with a fund, enabling organizations to track and manage multiple fundraising efforts across different funds simultaneously.

Attributes

_id

Required

string

The ID of the Campaign

name

Required

string

The name of the campaign

sellerId

Required

string

The ID of the seller owning the campaign

createdAt

Required

string date-time

An ISO timestamp indicating when the campaign was created.

updatedAt

Required

string date-time

An ISO timestamp indicating when the campaign was created.

Optional Attributes

Collapse all

target

Optional

object

The target (goal) amount and date of the campaign

Optional Attributes

Collapse all

target.amount

Optional

number

The target amount of the campaign

target.date

Optional

string date-time

An ISO timestamp indicating when the campaign is planned to reach the goal (amount).

externalId

Optional

string

The external ID of the campaign

Was this section helpful?

Yes No

{
  "_id": "string",
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Create a Campaign

Payload

name

Required

string

The name of the campaign

Optional Attributes

Collapse all

target

Optional

object

The target (goal) amount and date of the campaign

Optional Attributes

Collapse all

target.amount

Optional

number

The target amount of the campaign

target.date

Optional

string date-time

An ISO timestamp indicating when the campaign is planned to reach the goal (amount).

externalId

Optional

string

The external ID of the campaign

201

Created

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string"
}

{
  "_id": "string",
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Update a Campaign

Parameter

Required

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

Payload

Optional Attributes

Collapse all

name

Optional

string

The name of the campaign

target

Optional

object

The target (goal) amount and date of the campaign

Optional Attributes

Collapse all

target.amount

Optional

number

The target amount of the campaign

target.date

Optional

string date-time

An ISO timestamp indicating when the campaign is planned to reach the goal (amount).

externalId

Optional

string

The external ID of the campaign

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string"
}

{
  "_id": "string",
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get a Campaign

Parameter

Required

The ID or external ID of the campaign 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",
  "name": "string",
  "target": {
    "amount": 1,
    "date": "2030-01-23T23:00:00.123Z"
  },
  "externalId": "string",
  "sellerId": "string",
  "createdAt": "2030-01-23T23:00:00.123Z",
  "updatedAt": "2030-01-23T23:00:00.123Z"
}

Get All Campaigns

Query

top

Optional

integer

A limit on the number of objects to be returned. Can range between 1 and 1000.

skip

Optional

integer

The number of objects to skip for the requested result

_id

Optional

string

The ID of the campaign to search for

name

Optional

string

The name of the campaign to search for

externalId

Optional

string

The external ID of the campaign to search for

200

400

Bad Request

401

Unauthorized

Was this section helpful?

Yes No

{
  "docs": [
    {
      "_id": "string",
      "name": "string",
      "target": {
        "amount": 1,
        "date": "2030-01-23T23:00:00.123Z"
      },
      "externalId": "string",
      "sellerId": "string",
      "createdAt": "2030-01-23T23:00:00.123Z",
      "updatedAt": "2030-01-23T23:00:00.123Z"
    }
  ],
  "total": 1
}