latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Fundraisers

Create a Fundraiser

This request allows you to create a Fundraiser — a supporter-led fundraising page connected to a specific campaign. Learn more about how Fundraisers work in Fundraise Up.

post/v1/fundraisers

Request body

campaignstring required

Campaign ID. Must belong to the account that owns the API key, otherwise an error will occur. The campaign must be active and accept money-based donations, otherwise an error will occur.

descriptionstring required

Description of the Fundraiser

namestring required

The title of the Fundraiser, used as its main heading.

codestring

Identifier of up to 150 characters. Does not need to be unique.

currency'shp' | 'eur' | 'aed' | 'afn' | 'xcd' | 'all' | 'amd' | 'aoa' | 'ars' | 'usd' | 'aud' | 'ang' | 'xcg' | 'awg' | 'azn' | 'bam' | 'bbd' | 'inr' | 'pkr' | 'bdt' | 'xof' | 'bhd' | 'bif' | 'bmd' | 'myr' | 'bnd' | 'bob' | 'brl' | 'bsd' | 'btn' | 'nok' | 'zar' | 'bwp' | 'byn' | 'bzd' | 'cad' | 'cdf' | 'xaf' | 'chf' | 'nzd' | 'clp' | 'cny' | 'cop' | 'crc' | 'cve' | 'czk' | 'djf' | 'dkk' | 'dop' | 'dzd' | 'egp' | 'mad' | 'etb' | 'fjd' | 'fkp' | 'jpy' | 'gbp' | 'gel' | 'ghs' | 'gip' | 'gmd' | 'gnf' | 'gtq' | 'gyd' | 'hkd' | 'hnl' | 'htg' | 'huf' | 'idr' | 'ils' | 'isk' | 'jmd' | 'jod' | 'kes' | 'kgs' | 'khr' | 'kmf' | 'krw' | 'kwd' | 'kyd' | 'kzt' | 'lak' | 'lbp' | 'lkr' | 'lrd' | 'lsl' | 'mdl' | 'mga' | 'mkd' | 'mmk' | 'mnt' | 'mop' | 'mur' | 'mvr' | 'mwk' | 'mxn' | 'mzn' | 'nad' | 'xpf' | 'ngn' | 'nio' | 'sek' | 'npr' | 'omr' | 'pab' | 'pen' | 'pgk' | 'php' | 'pln' | 'pyg' | 'qar' | 'ron' | 'rsd' | 'rub' | 'rwf' | 'sar' | 'sbd' | 'scr' | 'sgd' | 'sle' | 'sos' | 'srd' | 'szl' | 'thb' | 'tjs' | 'tnd' | 'top' | 'try' | 'ttd' | 'twd' | 'tzs' | 'uah' | 'uyu' | 'uzs' | 'vnd' | 'vuv' | 'wst' | 'yer' | 'zmw'

Three-letter ISO currency code, in lowercase.

designationstring

Designation ID.

livemodeboolean

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026. Fundraisers only exist in live mode — set this to true.

slugstring

Unique identifier for the Fundraiser within the account or subaccount. The slug is not shared across accounts or subaccounts and must be unique within each. Can include up to 25 letters, numbers, underscores, or hyphens.

status'active' | 'paused'

Example request

{
  "campaign": "FUNXXXXXXXX",
  "description": "I'm raising money to help protect penguins and their habitat. Join me!",
  "name": "Run for hope",
  "code": "Winter appeal",
  "currency": "usd",
  "designation": "EXXXXXXX",
  "goal": {
    "amount": "99.99",
    "end_date": "2025-01-01"
  },
  "image": {
    "upload_url": "https://example.com/image.jpg"
  },
  "livemode": true,
  "slug": "5003-000000D8cu_IQAA"
}

Response

On success, the API returns the created Fundraiser object. If any parameters are invalid, the request returns an error response.

codestring nullable required

Code for the fundraiser, if applicable.

created_atstring required

Timestamp in ISO 8601 format, indicating when the fundraiser was created in UTC.

Three-letter ISO currency code, in lowercase.

descriptionstring required

Description of the Fundraiser.

idstring required

Unique identifier for the Fundraiser.

namestring required

The title of the Fundraiser, used as its main heading.

slugstring nullable required

Slug for the Fundraiser, if set.

status'active' | 'paused' required

Current status of the Fundraiser.

Example response

{
  "campaign": {
    "code": "Code-1",
    "id": "FUNXXXXXXXX",
    "name": "My Campaign"
  },
  "created_at": "2024-12-20T00:00:00.000Z",
  "currency": "usd",
  "designation": {
    "code": "Code-1",
    "id": "EXXXXXXX",
    "name": "My Designation"
  },
  "name": "Run for hope"
}