Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Fundraisers

Update a Fundraiser

This request allows you to update the details of a Fundraiser.

You can make updates to:

  • Enrich data.
  • Modify parameter values.
  • Remove parameter values.

The Fundraiser ID must belong to the account associated with the API key.

Fundraisers from subaccounts cannot be updated using the API key of the parent account. Attempting to do so will result in an error. To update a Fundraiser in a subaccount, you must use the API key of that subaccount.

For the update to succeed, the Fundraiser object must match the current campaign settings; otherwise, the operation will fail with a validation error.

Parallel requests to update the same object are not allowed and will result in an error.

Any parameters or child parameters that are not included will remain unchanged.

post/v1/fundraisers/{id}

Path parameters

idstring required
Example:NXXXXXXX

Unique identifier of the Fundraiser, formatted as N[A-Z]{7}.

Request body

campaignstring

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.

codestring

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

descriptionstring

Description of the Fundraiser

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.

namestring

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

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",
  "code": "Code-1",
  "description": "I'm raising money to help protect penguins and their habitat. Join me!",
  "designation": "EXXXXXXX",
  "goal": {
    "amount": "99.99",
    "end_date": "2025-01-01"
  },
  "image": {
    "upload_url": "https://example.com/image.jpg"
  },
  "livemode": true,
  "name": "Run for hope",
  "slug": "5003-000000D8cu_IQAA"
}

Response

On success, the API returns the Fundraiser object. If parameters are invalid, the call will return an error.

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.

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' required

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"
}